rubocop_todo_corrector 0.7.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f837600adefd9711b9b73eca485464781dcf9ba2bbf14bc2aec2f899c92c8ee5
-  data.tar.gz: cafef555598fc0f848bc739317fb3f9d507b227520f86f9fa4ffa1cc5d631b17
+  metadata.gz: 61752242b12ed25751b22323c3c0d177acefa0d89a23146607c126c3382921e7
+  data.tar.gz: be9d3d0f9c9428bdf7e2967a293dffe199539ea8a071545b0cbb4d914e1854c5
 SHA512:
-  metadata.gz: 3f0a064fa54502df60aba17ed32103b55f741704336a4fe2040c9478f5925b5bb2116bbf684fb3f2e8d64e9124408302185a1070f50fadc619a864010b2d45d6
-  data.tar.gz: 42479c0a9828bfed5899f1cfb3e1f5dbb847330f09aeda1a12126f62af3b8634879fca8177e955ba098c73d56702ec4d52cb983348892217fdc5907dc567f6cd
+  metadata.gz: 15a1cb26be0f48eca2430c827985be3eb9426684c9123a23d8f1d7f2c379cd56fda991edf58e6e25b58f65fd769919c20cad8ac9292b9c3a7576d272bc0b29e4
+  data.tar.gz: 3506ce4ca3b8fc368c79bd90ab6b18eb6cdabb35d6364891fc928917a5f232904cd020885915d0b2245fd720fe116f57ea7746759a9ca30b84051cc2a89e0cb3

data/CHANGELOG.md

@@ -2,6 +2,24 @@
 
 ## Unreleased
 
+## 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
+
+- Fix YARD unknown tag warning.
+
 ## 0.7.0 - 2022-05-27
 
 ### Added

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rubocop_todo_corrector (0.7.0)
+    rubocop_todo_corrector (0.9.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,6 +25,7 @@ gem install rubocop_todo_corrector
 $ 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 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.
@@ -33,78 +34,13 @@ Commands:
   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
-
-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.
-```
-
-### generate
-
-```console
-$ rubocop_todo_corrector help generate
-Usage:
-  rubocop_todo_corrector generate
+By specifying cop names in `.rubocop_todo_corrector_ignore`, you can exclude them from the selection.
 
-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.
+Style/StringConcatenation
+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

@@ -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,
@@ -68,6 +75,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/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,6 +3,7 @@
 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'

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'pathname'
+
+module RubocopTodoCorrector
+  class IgnoreFile
+    # @param [String] path
+    def initialize(path:)
+      @path = path
+    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
+
+    # @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.0'
+  VERSION = '0.9.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.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-26 00:00:00.000000000 Z
+date: 2022-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -75,6 +75,7 @@ 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
@@ -85,6 +86,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