rubocop_todo_corrector 0.7.1 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 78ebb6430a735647bdf5174b57e594385e52238e041622590771e0fe433b725f
-  data.tar.gz: d8bba18c545e8cae9ef03d271d432df33277e2c7ba92d578139d9425dd10cdc4
+  metadata.gz: e0b057086a834c7f6ec21014fae505b444094e01bc4556e47e91c81f387e3239
+  data.tar.gz: 8a56da11f2c70a840097588e539512e06edede97ba9fe185fd8df05096fa734f
 SHA512:
-  metadata.gz: 3eee8ffc0e2f7df0837613b06e65231b0c7013b69dae419ec7842f92354c350a7608a8ec0f9c8ba1a757b4308c90f5f7bcbe073ab49196e91c9295e11b0bcfb8
-  data.tar.gz: 47e6a365002f3c8e3e551f1020647e95e2dad184c3a561685ce56667cb773c9334d0bab2d72c23f650cb849a1c3c7d831ce3fbd499ca0558373e11ebfed772aa
+  metadata.gz: f54c8912b371c74034d95f1e46f18c07c9bc5c3544ea07ffdbd37650ac0980cfdf296485a798af14006ceaae2376c669bf53ea9dc64607402d63c91f6754a3c8
+  data.tar.gz: a2ffcc354d8508eb8164b1e45c4e2cd4927758f9963b900e74517a3edf523c00adb4a5235a005016ed486dddbef30be66eea7e8f129ab6496998e6775ac1e38c

data/CHANGELOG.md

@@ -2,6 +2,24 @@
 
 ## Unreleased
 
+## 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
+
+- Add `clean` command.
+
 ## 0.7.1 - 2022-05-28
 
 ### Fixed

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rubocop_todo_corrector (0.7.1)
+    rubocop_todo_corrector (0.10.0)
       bundler
       thor
       yard
@@ -50,7 +50,7 @@ GEM
     thor (1.2.1)
     unicode-display_width (2.1.0)
     webrick (1.7.0)
-    yard (0.9.27)
+    yard (0.9.28)
       webrick (~> 1.7.0)
 
 PLATFORMS

data/README.md

@@ -25,86 +25,25 @@ gem install rubocop_todo_corrector
 $ rubocop_todo_corrector
 Commands:
   rubocop_todo_corrector bundle                        # Run `bundle install` to install RuboCop related gems.
-  rubocop_todo_corrector correct                       # Run `rubocop --auto-correct-all`.
+  rubocop_todo_corrector clean                         # Remove temporary files.
+  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.
-```
-
-### correct
-
-```console
-Usage:
-  rubocop_todo_corrector correct
-
-Options:
-  [--only-safe], [--no-only-safe]
-                                   # Default: true
+By specifying cop names in `.rubocop_todo_corrector_ignore`, you can exclude them from the selection.
 
-Run `rubocop --auto-correct(-all)`.
 ```
+Style/StringConcatenation
 
-### 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.
+# Comment line is available like this.
+Style/StringLiterals
 ```
 
-### generate
-
-```console
-$ rubocop_todo_corrector help generate
-Usage:
-  rubocop_todo_corrector generate
-
-Run `rubocop --auto-gen-config` to generate .rubocop_todo.yml.
-```
-
-### 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.
-```
-
-### 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

@@ -14,6 +14,13 @@ module RubocopTodoCorrector
       )
     end
 
+    desc 'clean', 'Remove temporary files.'
+    def clean
+      Commands::Clean.call(
+        temporary_gemfile_path: 'tmp/Gemfile_rubocop_todo_corrector.rb'
+      )
+    end
+
     desc 'correct', 'Run `rubocop --auto-correct(-all)`.'
     option(
       :only_safe,
@@ -48,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,
@@ -68,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/clean.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+
+module RubocopTodoCorrector
+  module Commands
+    class Clean
+      class << self
+        # @param [String] temporary_gemfile_path
+        def call(
+          temporary_gemfile_path:
+        )
+          new(
+            temporary_gemfile_path:
+          ).call
+        end
+      end
+
+      def initialize(
+        temporary_gemfile_path:
+      )
+        @temporary_gemfile_path = temporary_gemfile_path
+      end
+
+      def call
+        ::FileUtils.rm_f(
+          [
+            @temporary_gemfile_path,
+            "#{@temporary_gemfile_path}.lock"
+          ]
+        )
+      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

@@ -3,9 +3,11 @@
 module RubocopTodoCorrector
   module Commands
     autoload :Bundle, 'rubocop_todo_corrector/commands/bundle'
+    autoload :Clean, 'rubocop_todo_corrector/commands/clean'
     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/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RubocopTodoCorrector
-  VERSION = '0.7.1'
+  VERSION = '0.10.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.7.1
+  version: 0.10.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-27 00:00:00.000000000 Z
+date: 2022-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -75,9 +75,11 @@ files:
 - lib/rubocop_todo_corrector/cli.rb
 - lib/rubocop_todo_corrector/commands.rb
 - lib/rubocop_todo_corrector/commands/bundle.rb
+- lib/rubocop_todo_corrector/commands/clean.rb
 - 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
@@ -85,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