rubocop_todo_corrector 0.5.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f41cc52c87afb8d1971ed4dbf006acd3471c42183e3c9947e588870a6bff7f3
-  data.tar.gz: dba2c971d07471a2b2da8b76eaf6ae1b8a27cde13698a116a97c7edfab2cdeb6
+  metadata.gz: 78ebb6430a735647bdf5174b57e594385e52238e041622590771e0fe433b725f
+  data.tar.gz: d8bba18c545e8cae9ef03d271d432df33277e2c7ba92d578139d9425dd10cdc4
 SHA512:
-  metadata.gz: 455f57a51dbd813148f3fde5d6c00f813e0edc47e2d5644b53efbe2bd3dda354fc4b6c52e952ca33b214309dc97ffe33a47f20fb5137759b224dcb4743fd11f5
-  data.tar.gz: 5d47b50b46c2fb7d79488ba0ef66bef0050483bb9c82ae346159ae69ba6b6e7145e2520658e41a914996e9d6bb6a17e4f125b1ce758c385326305cb8d6f8f2df
+  metadata.gz: 3eee8ffc0e2f7df0837613b06e65231b0c7013b69dae419ec7842f92354c350a7608a8ec0f9c8ba1a757b4308c90f5f7bcbe073ab49196e91c9295e11b0bcfb8
+  data.tar.gz: 47e6a365002f3c8e3e551f1020647e95e2dad184c3a561685ce56667cb773c9334d0bab2d72c23f650cb849a1c3c7d831ce3fbd499ca0558373e11ebfed772aa

data/CHANGELOG.md

@@ -2,6 +2,24 @@
 
 ## Unreleased
 
+## 0.7.1 - 2022-05-28
+
+### Fixed
+
+- Fix YARD unknown tag warning.
+
+## 0.7.0 - 2022-05-27
+
+### Added
+
+- Support rubocop 1.30 .rubocop_todo.yml format.
+
+## 0.6.0 - 2022-05-16
+
+### Added
+
+- Add `--only-safe` option to `correct` and `pick` command (default: `true`).
+
 ## 0.5.0 - 2022-05-16
 
 ### Changed

data/Gemfile.lock

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

data/README.md

@@ -29,7 +29,7 @@ Commands:
   rubocop_todo_corrector describe --cop-name=COP_NAME  # Output Markdown description for specified cop.
   rubocop_todo_corrector generate                      # Run `rubocop --auto-gen-config` to generate .rubocop_todo.yml.
   rubocop_todo_corrector help [COMMAND]                # Describe available commands or one specific command
-  rubocop_todo_corrector pick                          # Pick an auto-correctable Cop from .rubocop_todo.yml.
+  rubocop_todo_corrector pick                          # Output an auto-correctable Cop from .rubocop_todo.yml.
   rubocop_todo_corrector remove --cop-name=COP_NAME    # Remove section with specified cop name from .rubocop_todo.yml.
 ```
 
@@ -46,11 +46,14 @@ Run `bundle install` to install RuboCop related gems.
 ### correct
 
 ```console
-$ rubocop_todo_corrector help correct
 Usage:
   rubocop_todo_corrector correct
 
-Run `rubocop --auto-correct-all`.
+Options:
+  [--only-safe], [--no-only-safe]
+                                   # Default: true
+
+Run `rubocop --auto-correct(-all)`.
 ```
 
 ### describe
@@ -85,8 +88,10 @@ Usage:
 
 Options:
   [--mode=MODE]
-                 # Default: random
-                 # Possible values: first, last, least_occurred, most_occurred, random
+                                   # Default: random
+                                   # Possible values: first, last, least_occurred, most_occurred, random
+  [--only-safe], [--no-only-safe]
+                                   # Default: true
 
 Output an auto-correctable Cop from .rubocop_todo.yml.
 ```

data/lib/rubocop_todo_corrector/cli.rb

@@ -14,9 +14,15 @@ module RubocopTodoCorrector
       )
     end
 
-    desc 'correct', 'Run `rubocop --auto-correct-all`.'
+    desc 'correct', 'Run `rubocop --auto-correct(-all)`.'
+    option(
+      :only_safe,
+      default: true,
+      type: :boolean
+    )
     def correct
       Commands::Correct.call(
+        only_safe: options[:only_safe],
         temporary_gemfile_path: 'tmp/Gemfile_rubocop_todo_corrector.rb'
       )
     end
@@ -42,7 +48,7 @@ module RubocopTodoCorrector
       )
     end
 
-    desc 'pick', 'Pick an auto-correctable Cop from .rubocop_todo.yml.'
+    desc 'pick', 'Output an auto-correctable Cop from .rubocop_todo.yml.'
     option(
       :mode,
       default: 'random',
@@ -55,9 +61,15 @@ module RubocopTodoCorrector
       ],
       type: :string
     )
+    option(
+      :only_safe,
+      default: true,
+      type: :boolean
+    )
     def pick
       Commands::Pick.call(
         mode: options[:mode],
+        only_safe: options[:only_safe],
         rubocop_todo_path: '.rubocop_todo.yml'
       )
     end

data/lib/rubocop_todo_corrector/commands/correct.rb

@@ -4,28 +4,44 @@ module RubocopTodoCorrector
   module Commands
     class Correct
       class << self
+        # @param [Boolean] only_safe
         # @param [String] temporary_gemfile_path
         def call(
+          only_safe:,
           temporary_gemfile_path:
         )
           new(
+            only_safe:,
             temporary_gemfile_path:
           ).call
         end
       end
 
       def initialize(
+        only_safe:,
         temporary_gemfile_path:
       )
+        @only_safe = only_safe
         @temporary_gemfile_path = temporary_gemfile_path
       end
 
       def call
         ::Kernel.system(
           { 'BUNDLE_GEMFILE' => @temporary_gemfile_path },
-          'bundle exec rubocop --auto-correct-all'
+          "bundle exec rubocop #{rubocop_options}"
         )
       end
+
+      private
+
+      # @return [String]
+      def rubocop_options
+        if @only_safe
+          '--auto-correct'
+        else
+          '--auto-correct-all'
+        end
+      end
     end
   end
 end

data/lib/rubocop_todo_corrector/commands/pick.rb

@@ -7,13 +7,16 @@ module RubocopTodoCorrector
     class Pick
       class << self
         # @param [String] mode
+        # @param [Boolean] only_safe
         # @param [String] rubocop_todo_path
         def call(
           mode:,
+          only_safe:,
           rubocop_todo_path:
         )
           new(
             mode:,
+            only_safe:,
             rubocop_todo_path:
           ).call
         end
@@ -21,9 +24,11 @@ module RubocopTodoCorrector
 
       def initialize(
         mode:,
+        only_safe:,
         rubocop_todo_path:
       )
         @mode = mode
+        @only_safe = only_safe
         @rubocop_todo_path = rubocop_todo_path
       end
 
@@ -42,7 +47,11 @@ module RubocopTodoCorrector
       # @return [Array<Hash>]
       def auto_correctable_cops
         rubocop_todo[:cops].select do |cop|
-          cop[:auto_correctable]
+          if @only_safe
+            cop[:safe_auto_correctable]
+          else
+            cop[:auto_correctable]
+          end
         end
       end
 

data/lib/rubocop_todo_corrector/cop_document_parser.rb

@@ -42,6 +42,7 @@ module RubocopTodoCorrector
     # @return [YARD::CodeObjects::ClassObject]
     def yard_class_object
       @yard_class_object ||= begin
+        ::YARD::Tags::Library.define_tag('Cop Safety Information', :safety)
         ::YARD.parse(@source_path)
         yardoc = ::YARD::Registry.all(:class).first
         ::YARD::Registry.clear

data/lib/rubocop_todo_corrector/rubocop_todo_section_parser.rb

@@ -18,19 +18,18 @@ module RubocopTodoCorrector
     # @return [Hash]
     def call
       {
-        auto_correctable: auto_correctable?,
+        auto_correctable:,
         name:,
-        offenses_count:
+        offenses_count:,
+        safe_auto_correctable:
       }
     end
 
     private
 
     # @return [Boolean]
-    def auto_correctable?
-      @content.include?('# Cop supports --auto-correct') ||
-        @content.include?('# This cop supports safe auto-correction') ||
-        @content.include?('# This cop supports unsafe auto-correction')
+    def auto_correctable
+      safe_auto_correctable || unsafe_auto_correctable
     end
 
     # @return [String, nil]
@@ -45,5 +44,17 @@ module RubocopTodoCorrector
         'offenses_count'
       ]&.to_i
     end
+
+    def safe_auto_correctable
+      @content.include?('# Cop supports --auto-correct.') || # Before rubocop 1.26
+        @content.include?('# This cop supports safe auto-correction') || # Before rubocop 1.30
+        @content.include?('# This cop supports safe autocorrection')
+    end
+
+    def unsafe_auto_correctable
+      @content.include?('# Cop supports --auto-correct-all') ||
+        @content.include?('# This cop supports unsafe auto-correction') ||
+        @content.include?('# This cop supports unsafe autocorrection')
+    end
   end
 end

data/lib/rubocop_todo_corrector/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop_todo_corrector
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-15 00:00:00.000000000 Z
+date: 2022-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler