rubocop_todo_corrector 0.3.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff46eb10969e63064eaf439a4879103de5ea54ae8db44c7c185cb939e3d4b2fd
-  data.tar.gz: d1b4762bf9bdf6c98fb76311c5389b0175f39434c0f0ccfe8dc8ea4dcbecc3c3
+  metadata.gz: a16c0718e0411c212efc6aa1a070df5c0784c415b3ae25b47686c35d4a37f196
+  data.tar.gz: 38c4affee6edb3e6569a64df3d4b410522de4fee23c7f3849bbf9b7ccb1e67d9
 SHA512:
-  metadata.gz: 6290910045e5aa18a0c7e5689949836f687fb4d7fcd765769450d5a4c33d63476b99d9f2687be6bac7720cf13cc777b400e913f2f41d17a3fefc866eb70d6829
-  data.tar.gz: d739558dfa006d7110f36b9289505911cabbe9c500c00fb990781d04a9856a25db11910c1eae0fc9a8145e1e45955784b8a05f0706af710b106e4a35d5ba409a
+  metadata.gz: a31400bdfed79ab2ed935347885b40bae95956dec916b42dfb001b09507443ed3275cb003402bd427f73bd401006783360916c8f2de20e2382d5dbed18f70720
+  data.tar.gz: 8db623bd95d0f3c942df88e1ac720c296305c0f8b2b88371993906cc522253d1159a49c2bc8ac0e3c803c09d672804da908a2970b8d707f22d780ea81a291864

data/.rubocop.yml

@@ -4,7 +4,7 @@ require:
 
 AllCops:
   NewCops: enable
-  TargetRubyVersion: 3.0
+  TargetRubyVersion: 3.1
 
 Metrics:
   Enabled: false

data/CHANGELOG.md

@@ -2,6 +2,24 @@
 
 ## Unreleased
 
+## 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
+
+- Change required ruby version from 3.0 to 3.1.
+
+## 0.4.0 - 2022-05-16
+
+### Fixed
+
+- Fix misspell: `occured` -> `occurred`.
+
 ## 0.3.0 - 2022-05-15
 
 ### Changed

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rubocop_todo_corrector (0.3.0)
+    rubocop_todo_corrector (0.6.0)
       bundler
       thor
       yard
@@ -54,6 +54,7 @@ GEM
       webrick (~> 1.7.0)
 
 PLATFORMS
+  x86_64-darwin-21
   x86_64-linux
 
 DEPENDENCIES

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_occured, most_occured, 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/bundle_installer.rb

@@ -12,8 +12,8 @@ module RubocopTodoCorrector
         temporary_gemfile_path:
       )
         new(
-          gem_specifications: gem_specifications,
-          temporary_gemfile_path: temporary_gemfile_path
+          gem_specifications:,
+          temporary_gemfile_path:
         ).call
       end
     end

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,22 +48,28 @@ 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',
       enum: %w[
         first
         last
-        least_occured
-        most_occured
+        least_occurred
+        most_occurred
         random
       ],
       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/bundle.rb

@@ -13,9 +13,9 @@ module RubocopTodoCorrector
           temporary_gemfile_path:
         )
           new(
-            rubocop_configuration_path: rubocop_configuration_path,
-            gemfile_lock_path: gemfile_lock_path,
-            temporary_gemfile_path: temporary_gemfile_path
+            rubocop_configuration_path:,
+            gemfile_lock_path:,
+            temporary_gemfile_path:
           ).call
         end
       end
@@ -32,7 +32,7 @@ module RubocopTodoCorrector
 
       def call
         BundleInstaller.call(
-          gem_specifications: gem_specifications,
+          gem_specifications:,
           temporary_gemfile_path: @temporary_gemfile_path
         )
       end
@@ -51,9 +51,9 @@ module RubocopTodoCorrector
       def gem_specifications
         gem_names.map do |gem_name|
           {
-            gem_name: gem_name,
+            gem_name:,
             gem_version: GemVersionDetector.call(
-              gem_name: gem_name,
+              gem_name:,
               gemfile_lock_path: @gemfile_lock_path
             )
           }

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(
-            temporary_gemfile_path: temporary_gemfile_path
+            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/describe.rb

@@ -11,8 +11,8 @@ module RubocopTodoCorrector
           temporary_gemfile_path:
         )
           new(
-            cop_name: cop_name,
-            temporary_gemfile_path: temporary_gemfile_path
+            cop_name:,
+            temporary_gemfile_path:
           ).call
         end
       end
@@ -36,9 +36,9 @@ module RubocopTodoCorrector
         return unless cop_document
 
         description = DescriptionRenderer.call(
-          cop_document: cop_document,
+          cop_document:,
           cop_name: @cop_name,
-          cop_source_path: cop_source_path
+          cop_source_path:
         )
         ::Kernel.puts(description)
       end

data/lib/rubocop_todo_corrector/commands/generate.rb

@@ -13,8 +13,8 @@ module RubocopTodoCorrector
           temporary_gemfile_path:
         )
           new(
-            rubocop_todo_path: rubocop_todo_path,
-            temporary_gemfile_path: temporary_gemfile_path
+            rubocop_todo_path:,
+            temporary_gemfile_path:
           ).call
         end
       end

data/lib/rubocop_todo_corrector/commands/pick.rb

@@ -7,23 +7,28 @@ 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: mode,
-            rubocop_todo_path: rubocop_todo_path
+            mode:,
+            only_safe:,
+            rubocop_todo_path:
           ).call
         end
       end
 
       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
 
@@ -57,11 +66,11 @@ module RubocopTodoCorrector
           auto_correctable_cops.first
         when 'last'
           auto_correctable_cops.last
-        when 'least_occured'
+        when 'least_occurred'
           auto_correctable_cops.min_by do |cop|
             cop[:offenses_count]
           end
-        when 'most_occured'
+        when 'most_occurred'
           auto_correctable_cops.max_by do |cop|
             cop[:offenses_count]
           end

data/lib/rubocop_todo_corrector/commands/remove.rb

@@ -13,8 +13,8 @@ module RubocopTodoCorrector
           rubocop_todo_path:
         )
           new(
-            cop_name: cop_name,
-            rubocop_todo_path: rubocop_todo_path
+            cop_name:,
+            rubocop_todo_path:
           ).call
         end
       end

data/lib/rubocop_todo_corrector/cop_document_parser.rb

@@ -11,7 +11,7 @@ module RubocopTodoCorrector
         source_path:
       )
         new(
-          source_path: source_path
+          source_path:
         ).call
       end
     end

data/lib/rubocop_todo_corrector/cop_source_detector.rb

@@ -13,8 +13,8 @@ module RubocopTodoCorrector
         temporary_gemfile_path:
       )
         new(
-          cop_name: cop_name,
-          temporary_gemfile_path: temporary_gemfile_path
+          cop_name:,
+          temporary_gemfile_path:
         ).call
       end
     end

data/lib/rubocop_todo_corrector/description_renderer.rb

@@ -17,9 +17,9 @@ module RubocopTodoCorrector
         cop_source_path:
       )
         new(
-          cop_document: cop_document,
-          cop_name: cop_name,
-          cop_source_path: cop_source_path
+          cop_document:,
+          cop_name:,
+          cop_source_path:
         ).call
       end
     end

data/lib/rubocop_todo_corrector/gem_names_detector.rb

@@ -8,7 +8,7 @@ module RubocopTodoCorrector
       # @param [String] rubocop_configuration_path
       # @return [Array<String>]
       def call(rubocop_configuration_path:)
-        new(rubocop_configuration_path: rubocop_configuration_path).call
+        new(rubocop_configuration_path:).call
       end
     end
 

data/lib/rubocop_todo_corrector/gem_version_detector.rb

@@ -10,8 +10,8 @@ module RubocopTodoCorrector
       # @return [String, nil]
       def call(gemfile_lock_path:, gem_name:)
         new(
-          gemfile_lock_path: gemfile_lock_path,
-          gem_name: gem_name
+          gemfile_lock_path:,
+          gem_name:
         ).call
       end
     end

data/lib/rubocop_todo_corrector/rubocop_todo_parser.rb

@@ -16,7 +16,7 @@ module RubocopTodoCorrector
       # @param [String] content
       def call(content:)
         new(
-          content: content
+          content:
         ).call
       end
     end
@@ -28,8 +28,8 @@ module RubocopTodoCorrector
     # @return [Hash]
     def call
       {
-        cops: cops,
-        previous_rubocop_command: previous_rubocop_command
+        cops:,
+        previous_rubocop_command:
       }
     end
 

data/lib/rubocop_todo_corrector/rubocop_todo_section_parser.rb

@@ -6,7 +6,7 @@ module RubocopTodoCorrector
       # @param [String] content
       def call(content:)
         new(
-          content: content
+          content:
         ).call
       end
     end
@@ -18,19 +18,18 @@ module RubocopTodoCorrector
     # @return [Hash]
     def call
       {
-        auto_correctable: auto_correctable?,
-        name: name,
-        offenses_count: offenses_count
+        auto_correctable:,
+        name:,
+        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_corectable
     end
 
     # @return [String, nil]
@@ -45,5 +44,15 @@ module RubocopTodoCorrector
         'offenses_count'
       ]&.to_i
     end
+
+    def safe_auto_correctable
+      @content.include?('# Cop supports --auto-correct.') ||
+        @content.include?('# This cop supports safe auto-correction')
+    end
+
+    def unsafe_auto_corectable
+      @content.include?('# Cop supports --auto-correct-all') ||
+        @content.include?('# This cop supports unsafe auto-correction')
+    end
   end
 end

data/lib/rubocop_todo_corrector/version.rb

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

data/rubocop_todo_corrector.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.summary = 'Auto-correct offenses defined in .rubocop_todo.yml.'
   spec.homepage = 'https://github.com/r7kamura/rubocop_todo_corrector'
   spec.license = 'MIT'
-  spec.required_ruby_version = '>= 3.0'
+  spec.required_ruby_version = '>= 3.1'
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = spec.homepage

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop_todo_corrector
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-15 00:00:00.000000000 Z
+date: 2022-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -106,7 +106,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="