rubocop_todo_corrector 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0469c24b40b24ad6fca4beffd146ec75a86e8281fd921583b2d21272a8fe6b5
-  data.tar.gz: 71d344067d08cd32030426a584d36d3d86ab7ee68e3286388abee5c1bb94cbcb
+  metadata.gz: ff46eb10969e63064eaf439a4879103de5ea54ae8db44c7c185cb939e3d4b2fd
+  data.tar.gz: d1b4762bf9bdf6c98fb76311c5389b0175f39434c0f0ccfe8dc8ea4dcbecc3c3
 SHA512:
-  metadata.gz: 7017b6fbe186c776d52f4e2be3034a6a731b4fee473715bdf452fb4040bf86b4266d7cd228fea91ee5736db11dd86368bf474f52c24f3b0970f952bfab794185
-  data.tar.gz: e649442fb1953bc08512196cb597b6c201e47719fa862d0054289b956e3eef739c9467490f6c83e11a27bc88f66d0a1506094ce473483cb62224d2980f2193ad
+  metadata.gz: 6290910045e5aa18a0c7e5689949836f687fb4d7fcd765769450d5a4c33d63476b99d9f2687be6bac7720cf13cc777b400e913f2f41d17a3fefc866eb70d6829
+  data.tar.gz: d739558dfa006d7110f36b9289505911cabbe9c500c00fb990781d04a9856a25db11910c1eae0fc9a8145e1e45955784b8a05f0706af710b106e4a35d5ba409a

data/CHANGELOG.md

@@ -2,7 +2,33 @@
 
 ## Unreleased
 
-## 0.1.0
+## 0.3.0 - 2022-05-15
+
+### Changed
+
+- Change `describe` output so that commit-message-ready text is described.
+
+## 0.2.0 - 2022-05-15
+
+### Added
+
+- Add `correct` command.
+
+### Changed
+
+- Improve description on no named example.
+
+## 0.1.1 - 2022-05-15
+
+### Changed
+
+- Abort if no cop was picked on `pick` command.
+
+### Fixed
+
+- Fix bug that `pick` cannot find any cop on rubocop >= 1.26.
+
+## 0.1.0 - 2022-05-15
 
 ### Added
 

data/Gemfile.lock

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

data/README.md

@@ -1,6 +1,7 @@
 # RubocopTodoCorrector
 
 [![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.
 
@@ -24,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 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
@@ -41,6 +43,16 @@ Usage:
 Run `bundle install` to install RuboCop related gems.
 ```
 
+### correct
+
+```console
+$ rubocop_todo_corrector help correct
+Usage:
+  rubocop_todo_corrector correct
+
+Run `rubocop --auto-correct-all`.
+```
+
 ### describe
 
 ```console

data/lib/rubocop_todo_corrector/cli.rb

@@ -14,6 +14,13 @@ module RubocopTodoCorrector
       )
     end
 
+    desc 'correct', 'Run `rubocop --auto-correct-all`.'
+    def correct
+      Commands::Correct.call(
+        temporary_gemfile_path: 'tmp/Gemfile_rubocop_todo_corrector.rb'
+      )
+    end
+
     desc 'describe', 'Output Markdown description for specified cop.'
     option(
       :cop_name,

data/lib/rubocop_todo_corrector/commands/correct.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module RubocopTodoCorrector
+  module Commands
+    class Correct
+      class << self
+        # @param [String] temporary_gemfile_path
+        def call(
+          temporary_gemfile_path:
+        )
+          new(
+            temporary_gemfile_path: temporary_gemfile_path
+          ).call
+        end
+      end
+
+      def initialize(
+        temporary_gemfile_path:
+      )
+        @temporary_gemfile_path = temporary_gemfile_path
+      end
+
+      def call
+        ::Kernel.system(
+          { 'BUNDLE_GEMFILE' => @temporary_gemfile_path },
+          'bundle exec rubocop --auto-correct-all'
+        )
+      end
+    end
+  end
+end

data/lib/rubocop_todo_corrector/commands/describe.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'yard'
-
 module RubocopTodoCorrector
   module Commands
     class Describe

data/lib/rubocop_todo_corrector/commands/pick.rb

@@ -30,7 +30,11 @@ module RubocopTodoCorrector
       def call
         check_rubocop_todo_existence
         cop_name = picked_cop&.[](:name)
-        ::Kernel.puts cop_name if cop_name
+        if cop_name
+          ::Kernel.puts(cop_name)
+        else
+          ::Kernel.abort('No cop was picked.')
+        end
       end
 
       private

data/lib/rubocop_todo_corrector/commands.rb

@@ -3,6 +3,7 @@
 module RubocopTodoCorrector
   module Commands
     autoload :Bundle, 'rubocop_todo_corrector/commands/bundle'
+    autoload :Correct, 'rubocop_todo_corrector/commands/correct'
     autoload :Describe, 'rubocop_todo_corrector/commands/describe'
     autoload :Generate, 'rubocop_todo_corrector/commands/generate'
     autoload :Pick, 'rubocop_todo_corrector/commands/pick'

data/lib/rubocop_todo_corrector/cop_document_parser.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'yard'
+
 module RubocopTodoCorrector
   class CopDocumentParser
     class << self

data/lib/rubocop_todo_corrector/rubocop_todo_section_parser.rb

@@ -28,9 +28,9 @@ module RubocopTodoCorrector
 
     # @return [Boolean]
     def auto_correctable?
-      @content.include?('# Cop supports --auto-correct.') ||
-        @content.include?('# Cop supports safe auto-correction.') ||
-        @content.include?('# Cop supports unsafe auto-correction.')
+      @content.include?('# Cop supports --auto-correct') ||
+        @content.include?('# This cop supports safe auto-correction') ||
+        @content.include?('# This cop supports unsafe auto-correction')
     end
 
     # @return [String, nil]

data/lib/rubocop_todo_corrector/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RubocopTodoCorrector
-  VERSION = '0.1.0'
+  VERSION = '0.3.0'
 end

data/templates/description.md.erb

@@ -1,3 +1,5 @@
+Auto-correct <%= @cop_name %>
+
 ## Summary
 
 Auto-corrected [<%= @cop_name %>](<%= cop_url %>).
@@ -13,8 +15,10 @@ Auto-corrected [<%= @cop_name %>](<%= cop_url %>).
 >
 > #### Examples
 <% @cop_document[:examples].each do |example| -%>
+<% unless example[:name].empty? -%>
 >
 > <%= example[:name].strip %>
+<% end -%>
 >
 > ```ruby
 <% example[:text].each_line do |line| -%>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop_todo_corrector
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Ryo Nakamura
@@ -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/correct.rb
 - lib/rubocop_todo_corrector/commands/describe.rb
 - lib/rubocop_todo_corrector/commands/generate.rb
 - lib/rubocop_todo_corrector/commands/pick.rb