rubocop_todo_corrector 0.8.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86fbfcf2dc8bc54f4a72ce5c802c55063ca925e55174bdcc56ca9194fb9bade1
-  data.tar.gz: 7e95e96cbdffea5a2e8706fc496218a8f00288255a7cd32015a55589922cd642
+  metadata.gz: 1a5761497cb2e78d59de2fed8ce2abc7edd84bc318f6d70483ea1f4f9363a4a4
+  data.tar.gz: 1f310cfb7f1479f454914e3cbe1e40b065851c4e6978b484f2d617cd69df7d6c
 SHA512:
-  metadata.gz: b1baced0e45b00f3419ec85125d023737d1ca33af3ae642f175bcba37b275c517050f283974b63291ab432683a45fbb891f9a961ea17cc4fa86e825d9bf35654
-  data.tar.gz: 807219d3418b38e8383e40b557ccc93b1e685d6011c669407bab48364eabd3d3bd9f0efa35319b50ee7055e4af798f73b4d4b1ad09a76495bedcb5e9d04c2e84
+  metadata.gz: 227d12206f9b090ba98cae89ac3e960c1f6e1d61a8bcffe501c093ccffca1dd68b7121659977bc7835f1270994c3f63914f0e14bcd5cd040b66d699926339620
+  data.tar.gz: d88f4a1733519d7e0f5659ae62474bd0c37c2b06d0284b64fdd94d3a210ac99655a666ce3ab8bdb67cce6118c7f57edcaba7f83cb5de13e52a30523c4b9957b7

data/CHANGELOG.md

@@ -2,6 +2,24 @@
 
 ## Unreleased
 
+## 0.11.0 - 2022-07-29
+
+### Changed
+
+- Use `rubocop --regenerate-todo` option on `generate` command.
+
+## 0.10.0 - 2022-07-27
+
+### Added
+
+- Add `ignore` command.
+
+## 0.9.0 - 2022-07-27
+
+### Added
+
+- Add `.rubocop_todo_corrector_ignore` file support.
+
 ## 0.8.0 - 2022-07-23
 
 ### Added

data/Gemfile.lock

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

data/README.md

@@ -26,96 +26,24 @@ $ rubocop_todo_corrector
 Commands:
   rubocop_todo_corrector bundle                        # Run `bundle install` to install RuboCop related gems.
   rubocop_todo_corrector clean                         # Remove temporary files.
-  rubocop_todo_corrector correct                       # Run `rubocop --auto-correct-all`.
+  rubocop_todo_corrector correct                       # Run `rubocop --auto-correct(-all)`.
   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 ignore --cop-name=COP_NAME    # Ignore specified cop by appending it to ignore file.
   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.
 ```
 
-### bundle
+### .rubocop_todo_corrector_ignore
 
-```console
-$ rubocop_todo_corrector help bundle
-Usage:
-  rubocop_todo_corrector bundle
-
-Run `bundle install` to install RuboCop related gems.
-```
-
-### Clean
-
-```console
-$ rubocop_todo_corrector help clean
-Usage:
-  rubocop_todo_corrector clean
-
-Remove temporary files.
-```
-
-### correct
-
-```console
-Usage:
-  rubocop_todo_corrector correct
-
-Options:
-  [--only-safe], [--no-only-safe]
-                                   # Default: true
-
-Run `rubocop --auto-correct(-all)`.
-```
-
-### describe
-
-```console
-$ rubocop_todo_corrector help describe
-Usage:
-  rubocop_todo_corrector describe --cop-name=COP_NAME
-
-Options:
-  --cop-name=COP_NAME
-
-Output Markdown description for specified cop.
-```
+By specifying cop names in `.rubocop_todo_corrector_ignore`, you can exclude them from the selection.
 
-### generate
-
-```console
-$ rubocop_todo_corrector help generate
-Usage:
-  rubocop_todo_corrector generate
-
-Run `rubocop --auto-gen-config` to generate .rubocop_todo.yml.
 ```
+Style/StringConcatenation
 
-### pick
-
-```console
-$ rubocop_todo_corrector help pick
-Usage:
-  rubocop_todo_corrector pick
-
-Options:
-  [--mode=MODE]
-                                   # 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.
+# Comment line is available like this.
+Style/StringLiterals
 ```
 
-### remove
-
-```console
-$ rubocop_todo_corrector help remove
-Usage:
-  rubocop_todo_corrector remove --cop-name=COP_NAME
-
-Options:
-  --cop-name=COP_NAME
-
-Remove section with specified cop name from .rubocop_todo.yml.
-```
+This is useful, for example, when you find a cop that cannot be autocorrected.

data/lib/rubocop_todo_corrector/cli.rb

@@ -55,6 +55,19 @@ module RubocopTodoCorrector
       )
     end
 
+    desc 'ignore', 'Ignore specified cop by appending it to ignore file.'
+    option(
+      :cop_name,
+      type: :string,
+      required: true
+    )
+    def ignore
+      Commands::Ignore.call(
+        ignore_file_path: '.rubocop_todo_corrector_ignore',
+        cop_name: options[:cop_name]
+      )
+    end
+
     desc 'pick', 'Output an auto-correctable Cop from .rubocop_todo.yml.'
     option(
       :mode,
@@ -75,6 +88,7 @@ module RubocopTodoCorrector
     )
     def pick
       Commands::Pick.call(
+        ignore_file_path: '.rubocop_todo_corrector_ignore',
         mode: options[:mode],
         only_safe: options[:only_safe],
         rubocop_todo_path: '.rubocop_todo.yml'

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'pathname'
+
+module RubocopTodoCorrector
+  module Commands
+    class Ignore
+      class << self
+        # @param [String] cop_name
+        # @param [String] ignore_file_path
+        def call(
+          cop_name:,
+          ignore_file_path:
+        )
+          new(
+            cop_name:,
+            ignore_file_path:
+          ).call
+        end
+      end
+
+      def initialize(
+        cop_name:,
+        ignore_file_path:
+      )
+        @cop_name = cop_name
+        @ignore_file_path = ignore_file_path
+      end
+
+      def call
+        IgnoreFile.new(path: @ignore_file_path).append_cop_name(@cop_name)
+      end
+    end
+  end
+end

data/lib/rubocop_todo_corrector/commands/pick.rb

@@ -1,20 +1,24 @@
 # frozen_string_literal: true
 
 require 'pathname'
+require 'set'
 
 module RubocopTodoCorrector
   module Commands
     class Pick
       class << self
+        # @param [String] ignore_file_path
         # @param [String] mode
         # @param [Boolean] only_safe
         # @param [String] rubocop_todo_path
         def call(
+          ignore_file_path:,
           mode:,
           only_safe:,
           rubocop_todo_path:
         )
           new(
+            ignore_file_path:,
             mode:,
             only_safe:,
             rubocop_todo_path:
@@ -23,10 +27,12 @@ module RubocopTodoCorrector
       end
 
       def initialize(
+        ignore_file_path:,
         mode:,
         only_safe:,
         rubocop_todo_path:
       )
+        @ignore_file_path = ignore_file_path
         @mode = mode
         @only_safe = only_safe
         @rubocop_todo_path = rubocop_todo_path
@@ -59,23 +65,37 @@ module RubocopTodoCorrector
         raise "#{rubocop_todo_pathname.to_s.inspect} does not exist." unless rubocop_todo_pathname.exist?
       end
 
+      # @return [Set<String>]
+      def ignored_cop_names
+        @ignored_cop_names ||= IgnoreFile.new(
+          path: @ignore_file_path
+        ).ignored_cop_names.to_set
+      end
+
+      # @return [Array<Hash>]
+      def pickable_cops
+        auto_correctable_cops.reject do |cop|
+          ignored_cop_names.include?(cop[:name])
+        end
+      end
+
       # @return [Hash, nil]
       def picked_cop
         case @mode
         when 'first'
-          auto_correctable_cops.first
+          pickable_cops.first
         when 'last'
-          auto_correctable_cops.last
+          pickable_cops.last
         when 'least_occurred'
-          auto_correctable_cops.min_by do |cop|
+          pickable_cops.min_by do |cop|
             cop[:offenses_count]
           end
         when 'most_occurred'
-          auto_correctable_cops.max_by do |cop|
+          pickable_cops.max_by do |cop|
             cop[:offenses_count]
           end
         else
-          auto_correctable_cops.sample
+          pickable_cops.sample
         end
       end
 

data/lib/rubocop_todo_corrector/commands.rb

@@ -7,6 +7,7 @@ module RubocopTodoCorrector
     autoload :Correct, 'rubocop_todo_corrector/commands/correct'
     autoload :Describe, 'rubocop_todo_corrector/commands/describe'
     autoload :Generate, 'rubocop_todo_corrector/commands/generate'
+    autoload :Ignore, 'rubocop_todo_corrector/commands/ignore'
     autoload :Pick, 'rubocop_todo_corrector/commands/pick'
     autoload :Remove, 'rubocop_todo_corrector/commands/remove'
   end

data/lib/rubocop_todo_corrector/ignore_file.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'pathname'
+
+module RubocopTodoCorrector
+  class IgnoreFile
+    # @param [String] path
+    def initialize(path:)
+      @path = path
+    end
+
+    # @param [String] cop_name
+    def append_cop_name(cop_name)
+      return if include?(cop_name)
+
+      appendix = "#{cop_name}\n"
+      appendix.prepend("\n") if !content.empty? && !content.end_with?("\n")
+      pathname.write("#{content}#{appendix}")
+    end
+
+    # @return [Array<String>]
+    def ignored_cop_names
+      content.split("\n").map do |line|
+        line.sub(/#.+/, '').strip
+      end.reject(&:empty?)
+    end
+
+    private
+
+    # @return [String]
+    def content
+      if pathname.exist?
+        pathname.read
+      else
+        ''
+      end
+    end
+
+    # @param [String] cop_name
+    # @return [Boolean]
+    def include?(cop_name)
+      ignored_cop_names.include?(cop_name)
+    end
+
+    # @return [Pathname]
+    def pathname
+      @pathname ||= ::Pathname.new(@path)
+    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.8.0'
+  VERSION = '0.11.0'
 end

data/lib/rubocop_todo_corrector.rb

@@ -11,6 +11,7 @@ module RubocopTodoCorrector
   autoload :DescriptionRenderer, 'rubocop_todo_corrector/description_renderer'
   autoload :GemNamesDetector, 'rubocop_todo_corrector/gem_names_detector'
   autoload :GemVersionDetector, 'rubocop_todo_corrector/gem_version_detector'
+  autoload :IgnoreFile, 'rubocop_todo_corrector/ignore_file'
   autoload :RubocopTodoParser, 'rubocop_todo_corrector/rubocop_todo_parser'
   autoload :RubocopTodoSectionParser, 'rubocop_todo_corrector/rubocop_todo_section_parser'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop_todo_corrector
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-23 00:00:00.000000000 Z
+date: 2022-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -79,6 +79,7 @@ files:
 - lib/rubocop_todo_corrector/commands/correct.rb
 - lib/rubocop_todo_corrector/commands/describe.rb
 - lib/rubocop_todo_corrector/commands/generate.rb
+- lib/rubocop_todo_corrector/commands/ignore.rb
 - lib/rubocop_todo_corrector/commands/pick.rb
 - lib/rubocop_todo_corrector/commands/remove.rb
 - lib/rubocop_todo_corrector/cop_document_parser.rb
@@ -86,6 +87,7 @@ files:
 - lib/rubocop_todo_corrector/description_renderer.rb
 - lib/rubocop_todo_corrector/gem_names_detector.rb
 - lib/rubocop_todo_corrector/gem_version_detector.rb
+- lib/rubocop_todo_corrector/ignore_file.rb
 - lib/rubocop_todo_corrector/rubocop_todo_parser.rb
 - lib/rubocop_todo_corrector/rubocop_todo_section_parser.rb
 - lib/rubocop_todo_corrector/version.rb