rubocop_todo_corrector 0.9.0 → 0.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61752242b12ed25751b22323c3c0d177acefa0d89a23146607c126c3382921e7
-  data.tar.gz: be9d3d0f9c9428bdf7e2967a293dffe199539ea8a071545b0cbb4d914e1854c5
+  metadata.gz: 1725e72b773d02b2b00407840e3cc9c6f1369efa22fc81f335dda6b3959080cd
+  data.tar.gz: 01c22d85c57ea1d2cdfdd692cef1c92764025cacdda049b65d146731a6ed723a
 SHA512:
-  metadata.gz: 15a1cb26be0f48eca2430c827985be3eb9426684c9123a23d8f1d7f2c379cd56fda991edf58e6e25b58f65fd769919c20cad8ac9292b9c3a7576d272bc0b29e4
-  data.tar.gz: 3506ce4ca3b8fc368c79bd90ab6b18eb6cdabb35d6364891fc928917a5f232904cd020885915d0b2245fd720fe116f57ea7746759a9ca30b84051cc2a89e0cb3
+  metadata.gz: fd2ceb4d8b406bb5e2e03feeb155b46ba8013ca8080d5667379c002b9b56c36473d9d62292b3aedb262ed2ecfb447608903ff704a01ae53a8d2de62a8f785858
+  data.tar.gz: e81181f9fb7919e5066d265ef7250127d99fbf06ef7fc0a0c5c5eb3f5c7c58f25bd7dcb513c4d10742cf63651d6b12d15475744593b66eb0efd457251da7b814

data/CHANGELOG.md

@@ -2,6 +2,24 @@
 
 ## Unreleased
 
+## 0.11.1 - 2022-08-03
+
+### Fixed
+
+- Fix `describe` command on more than three nested cop class.
+
+## 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

data/Gemfile.lock

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

data/README.md

@@ -3,7 +3,9 @@
 [![test](https://github.com/r7kamura/rubocop_todo_corrector/actions/workflows/test.yml/badge.svg)](https://github.com/r7kamura/rubocop_todo_corrector/actions/workflows/test.yml)
 [![Gem Version](https://badge.fury.io/rb/rubocop_todo_corrector.svg)](https://rubygems.org/gems/rubocop_todo_corrector)
 
-Auto-correct offenses defined in .rubocop_todo.yml.
+Auto-correct offenses defined in `.rubocop_todo.yml`.
+
+This is an internal implementation of [rubocop-todo-corrector](https://github.com/r7kamura/rubocop-todo-corrector) action. See its README for more information about this action.
 
 ## Installation
 
@@ -26,10 +28,11 @@ $ 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.
 ```
@@ -40,6 +43,8 @@ By specifying cop names in `.rubocop_todo_corrector_ignore`, you can exclude the
 
 ```
 Style/StringConcatenation
+
+# Comment line is available like this.
 Style/StringLiterals
 ```
 

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,

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

@@ -45,7 +45,7 @@ module RubocopTodoCorrector
 
     # @return [String]
     def cop_class_name
-      "RuboCop::Cop::#{@cop_name.sub('/', '::')}"
+      "RuboCop::Cop::#{@cop_name.gsub('/', '::')}"
     end
   end
 end

data/lib/rubocop_todo_corrector/ignore_file.rb

@@ -9,6 +9,15 @@ module RubocopTodoCorrector
       @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|
@@ -27,6 +36,12 @@ module RubocopTodoCorrector
       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)

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.9.0'
+  VERSION = '0.11.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop_todo_corrector
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.11.1
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-26 00:00:00.000000000 Z
+date: 2022-08-03 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