rubocop_todo_corrector 0.1.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b3400e2c32ebba2820631095ea0a4468f81145edd4328472b13901f40fa1909
-  data.tar.gz: b6922a0b1da93adec490cabd5a59870d0412f2ef7bbd412173ca093b42e8f363
+  metadata.gz: c85c8d566f2b49425a572f879680331084e81e9d3ef8de784f01d76a02405ea2
+  data.tar.gz: b42c06c055c914dd5ec4c26147c9de35f77361b08b621d3dd415d9bbbe498408
 SHA512:
-  metadata.gz: 4fe20782d6f29b60c55f6f0478345029fa73df46515e9d117aa640969c2683a684977943a2c63bbcf08b57be3e05531e468bd08837683e3139328f95f9db2643
-  data.tar.gz: de6bd6fd3f51f3004ad8f1e83c470ca630a71d0bf8489a6469bd49471fdfac649f898b477a058e78fed84a2a445af8be190a9396d7a7091eca19c9c2a834cbc1
+  metadata.gz: 30fe5e842703e0f9416d15fa5a11a36c8caf66481266381fcad1fcf422bb6b21632276119e3c442710e45a9728ca8c87c035883adb19d59a8a1c966f15d7f989
+  data.tar.gz: c8bbb8075412c6f784e39f73455371fabd593e2c3ca9409eb68abd683f54b4170aa46e94375c6f3c6db2cd5a4a72808cc7b8c6acd999e3131f7ba8efb36b155b

data/CHANGELOG.md

@@ -2,6 +2,28 @@
 
 ## Unreleased
 
+## 0.4.0 - 2022-05-16
+
+### Fixed
+
+- Fix misspell: `occured` -> `occurred`.
+
+## 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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rubocop_todo_corrector (0.1.1)
+    rubocop_todo_corrector (0.4.0)
       bundler
       thor
       yard
@@ -54,6 +54,7 @@ GEM
       webrick (~> 1.7.0)
 
 PLATFORMS
+  x86_64-darwin-21
   x86_64-linux
 
 DEPENDENCIES

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
@@ -74,7 +86,7 @@ Usage:
 Options:
   [--mode=MODE]
                  # Default: random
-                 # Possible values: first, last, least_occured, most_occured, random
+                 # Possible values: first, last, least_occurred, most_occurred, random
 
 Output an auto-correctable Cop from .rubocop_todo.yml.
 ```

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,
@@ -42,8 +49,8 @@ module RubocopTodoCorrector
       enum: %w[
         first
         last
-        least_occured
-        most_occured
+        least_occurred
+        most_occurred
         random
       ],
       type: :string

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

@@ -57,11 +57,11 @@ module RubocopTodoCorrector
           auto_correctable_cops.first
         when 'last'
           auto_correctable_cops.last
-        when 'least_occured'
+        when 'least_occurred'
           auto_correctable_cops.min_by do |cop|
             cop[:offenses_count]
           end
-        when 'most_occured'
+        when 'most_occurred'
           auto_correctable_cops.max_by do |cop|
             cop[:offenses_count]
           end

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.4.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.1
+  version: 0.4.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