rubocop_todo_corrector 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61752242b12ed25751b22323c3c0d177acefa0d89a23146607c126c3382921e7
-  data.tar.gz: be9d3d0f9c9428bdf7e2967a293dffe199539ea8a071545b0cbb4d914e1854c5
+  metadata.gz: e0b057086a834c7f6ec21014fae505b444094e01bc4556e47e91c81f387e3239
+  data.tar.gz: 8a56da11f2c70a840097588e539512e06edede97ba9fe185fd8df05096fa734f
 SHA512:
-  metadata.gz: 15a1cb26be0f48eca2430c827985be3eb9426684c9123a23d8f1d7f2c379cd56fda991edf58e6e25b58f65fd769919c20cad8ac9292b9c3a7576d272bc0b29e4
-  data.tar.gz: 3506ce4ca3b8fc368c79bd90ab6b18eb6cdabb35d6364891fc928917a5f232904cd020885915d0b2245fd720fe116f57ea7746759a9ca30b84051cc2a89e0cb3
+  metadata.gz: f54c8912b371c74034d95f1e46f18c07c9bc5c3544ea07ffdbd37650ac0980cfdf296485a798af14006ceaae2376c669bf53ea9dc64607402d63c91f6754a3c8
+  data.tar.gz: a2ffcc354d8508eb8164b1e45c4e2cd4927758f9963b900e74517a3edf523c00adb4a5235a005016ed486dddbef30be66eea7e8f129ab6496998e6775ac1e38c

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## Unreleased
 
+## 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.10.0)
       bundler
       thor
       yard

data/README.md

@@ -26,10 +26,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 +41,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/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/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/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RubocopTodoCorrector
-  VERSION = '0.9.0'
+  VERSION = '0.10.0'
 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.10.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-26 00:00:00.000000000 Z
+date: 2022-07-27 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