rubocop_todo_corrector 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b3400e2c32ebba2820631095ea0a4468f81145edd4328472b13901f40fa1909
-  data.tar.gz: b6922a0b1da93adec490cabd5a59870d0412f2ef7bbd412173ca093b42e8f363
+  metadata.gz: c417bdeb50548dfac237a4360a258e4e49d20fbb5b0eedc3912e4fae7bcf9197
+  data.tar.gz: 73549fca6bd871bd64a908c63a31776c5d7cef57cce9173e25981139634f406c
 SHA512:
-  metadata.gz: 4fe20782d6f29b60c55f6f0478345029fa73df46515e9d117aa640969c2683a684977943a2c63bbcf08b57be3e05531e468bd08837683e3139328f95f9db2643
-  data.tar.gz: de6bd6fd3f51f3004ad8f1e83c470ca630a71d0bf8489a6469bd49471fdfac649f898b477a058e78fed84a2a445af8be190a9396d7a7091eca19c9c2a834cbc1
+  metadata.gz: 4844bfb173d37e49fe941924155c854ebc760ed2fbfa6708eb674acd9a819683b67a44e46d5f9f1a3fab23e50813eea6f6139109aaa0f5ebd133b130b58ea50a
+  data.tar.gz: 936d187e8abfa84ae37062473a05c4acc74868e97c6982b1572f866701f1efd0c60f36ef5c50f1cfb0b93e49e8354d00952e043bff49d5032936c2853f36c572

data/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 ## Unreleased
 
+## 0.2.0 - 2022-05-15
+
+### Added
+
+- Add `correct` command.
+
+### Changed
+
+- Improve description on no named example.
+
 ## 0.1.1 - 2022-05-15
 
 ### Changed

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

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

data/templates/description.md.erb

@@ -13,8 +13,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.1
+  version: 0.2.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