rubocop_challenger 2.8.0 → 2.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '069b4741c020bd27b620bcf7e5cac220bd9f80de03735751598e148d7c622a0a'
-  data.tar.gz: 0a9eedf4aed6d0154be1cd70f53ac4a573fcdc349b0be4611b60e8f3463f2c6f
+  metadata.gz: d5a129ffbdfa720d2d61386e268ccfbff06005cd0f59f04ff5e4fbc843a82b0c
+  data.tar.gz: 7a6a2de90d5077852ab9c8ae16a9cb409b4319136a776bf1f82fc614c44b1011
 SHA512:
-  metadata.gz: 4b87dea0df5bbb1e54e9296d71752be6d5af85dc57374da52c34431175e831e103f2c45d565e22e0b6e6c5bc4e6bdca95761a849489984699f4aa4721c306f84
-  data.tar.gz: 54357ce576a82ea8c950fc2d0ed1c21b956e04fc971659b05b3e62d43696850fb59394943ba30f761674f07462474037fdfb6ffb87780f2e5d33f588da37ea8a
+  metadata.gz: 046a667891ec84c62ae768b3ba3ef28ab906c2e4e4df94bbb74950ab6db66c0157290975d223a0d1fe1d49d1d026ab88a8870195a1d0c6c09d866aaa80f1cd55
+  data.tar.gz: cc60705e93e82bd5d482ddc7a7b493f636e60286cf83527cf6dbddc1538a47dac18d7f014ea0935c9c5ec3725faff9f15154275330ac570fbe0b84df85140dbd

data/.circleci/config.yml

@@ -96,6 +96,7 @@ commands:
       - verify_rubocop_challenge
       - verify_rubocop_challenge
       - verify_rubocop_challenge
+      - rubocop
   rubocop_challenge:
     steps:
       - run:

data/CHANGELOG.md

@@ -1,15 +1,25 @@
 # Change log
 
+## v2.9.0 (Jun 02, 2022)
+
+### Feature
+
+- [#628](https://github.com/ryz310/rubocop_challenger/pull/628) Change `auto-correct` to `autocorrect` ([@ryz310](https://github.com/ryz310))
+
+### Dependabot
+
+- [#629](https://github.com/ryz310/rubocop_challenger/pull/629) Bump yard from 0.9.27 to 0.9.28 ([@ryz310](https://github.com/ryz310))
+
 ## v2.8.0 (May 30, 2022)
 
 ### Feature
 
 - [#616](https://github.com/ryz310/rubocop_challenger/pull/616) Support `--no-offense-counts` option ([@ryz310](https://github.com/ryz310))
+- [#625](https://github.com/ryz310/rubocop_challenger/pull/625) Use `--conservative` option on `bundle update` ([@ryz310](https://github.com/ryz310))
 
 ### Bugfix
 
 - [#612](https://github.com/ryz310/rubocop_challenger/pull/612) Fix wrong usage of `Array#reject!`: this might return nil ([@r7kamura](https://github.com/r7kamura))
-- [#625](https://github.com/ryz310/rubocop_challenger/pull/625) Use `--conservative` option on `bundle update` ([@ryz310](https://github.com/ryz310))
 
 ### Breaking Change
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rubocop_challenger (2.8.0)
+    rubocop_challenger (2.9.0)
       pr_comet (>= 0.5.1, < 0.7.0)
       rainbow
       rubocop (>= 0.87)
@@ -113,7 +113,7 @@ GEM
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.1.0)
     webrick (1.7.0)
-    yard (0.9.27)
+    yard (0.9.28)
       webrick (~> 1.7.0)
 
 PLATFORMS

data/README.md

@@ -3,14 +3,14 @@
 [![CircleCI](https://circleci.com/gh/ryz310/rubocop_challenger/tree/master.svg?style=svg&circle-token=cdf0ffce5b4c0c7804b50dde00ca5ef09cbadb67)](https://circleci.com/gh/ryz310/rubocop_challenger/tree/master) [![Gem Version](https://badge.fury.io/rb/rubocop_challenger.svg)](https://badge.fury.io/rb/rubocop_challenger) [![Maintainability](https://api.codeclimate.com/v1/badges/a18c1c17fc534bb32473/maintainability)](https://codeclimate.com/github/ryz310/rubocop_challenger/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/a18c1c17fc534bb32473/test_coverage)](https://codeclimate.com/github/ryz310/rubocop_challenger/test_coverage)
 
 If you introduce [`rubocop`](https://github.com/rubocop-hq/rubocop) to an existing Rails project later, you will use [`$ rubocop --auto-gen-config`](https://github.com/rubocop-hq/rubocop/blob/master/manual/configuration.md#automatically-generated-configuration). But it will make a huge `.rubocop_todo.yml` and make you despair.
-On the other hand, `rubocop` has [`--auto-correct`](https://github.com/rubocop-hq/rubocop/blob/master/manual/basic_usage.md#other-useful-command-line-flags) option, it is possible to automatically repair the writing which does not conform to the rule. But since it occasionally destroys your code, it is quite dangerous to apply all at once.
+On the other hand, `rubocop` has [`--autocorrect`](https://github.com/rubocop-hq/rubocop/blob/master/manual/basic_usage.md#other-useful-command-line-flags) option, it is possible to automatically repair the writing which does not conform to the rule. But since it occasionally destroys your code, it is quite dangerous to apply all at once.
 It is ideal that to remove a disabled rule from `.rubocop_todo.yml` every day, to check whether it passes test, and can be obtained consent from the team. But it requires strong persistence and time.
 I call such work _Rubocop Challenge_. And the _RubocopChallenger_ is a gem to support this challenge!
 
 ## The history of RubocopChallenger with decrease of offense codes
 
-The following chart shows the history of RubocopChallenger and decrease of offense codes at a `.rubocop_todo.yml`. The project was released at 5 years ago, and then it was introduced the RuboCop gem for huge source code including a lots of offense codes. Before using the RubocopChallenger, it was not maintain to reduce offense codes. One day, I felt a crisis and started maintain with manual. I made a lots of Pull Requests to reduce them but it's a load for me and reviewers. So I created a script for automation the flow, which is the predecessor of Rubocop Challenger gem. It brought reducing the offense codes continuously. After 8 months, finally it has done. There is no auto-correctable offense codes.
-But there are many offenses which is un-auto-correctable yet. I will try to reduce it with the RubocopChallenger. The RubocopChallenger will
+The following chart shows the history of RubocopChallenger and decrease of offense codes at a `.rubocop_todo.yml`. The project was released at 5 years ago, and then it was introduced the RuboCop gem for huge source code including a lots of offense codes. Before using the RubocopChallenger, it was not maintain to reduce offense codes. One day, I felt a crisis and started maintain with manual. I made a lots of Pull Requests to reduce them but it's a load for me and reviewers. So I created a script for automation the flow, which is the predecessor of Rubocop Challenger gem. It brought reducing the offense codes continuously. After 8 months, finally it has done. There is no autocorrectable offense codes.
+But there are many offenses which is un-autocorrectable yet. I will try to reduce it with the RubocopChallenger. The RubocopChallenger will
 be continued to evolve.
 
 ![Decrease of offense codes](images/decrease_of_offense_codes.png)
@@ -18,7 +18,7 @@ be continued to evolve.
 ## Rubocop Challenge Flow
 
 1. Run _RubocopChallenger_ periodically from CI tool etc.
-1. When _RubocopChallenger_ starts, delete a disabled rule from `.rubocop_todo.yml` existing in your project, execute `$ rubocop --auto-correct` and create a PR which include modified results
+1. When _RubocopChallenger_ starts, delete a disabled rule from `.rubocop_todo.yml` existing in your project, execute `$ rubocop --autocorrect` and create a PR which include modified results
 1. You confirm the PR passes testing and then merge it if there is no problem
 
 [![Rubocop Challenge](images/rubocop_challenge.png)](https://github.com/ryz310/rubocop_challenger/pull/97)
@@ -88,7 +88,7 @@ See: [RuboCop Challenger を GitHub Actions で動かす](https://zenn.dev/yamat
 $ rubocop_challenger help
 
 Commands:
-  rubocop_challenger go --email=EMAIL --name=NAME  # Run `$ rubocop --auto-correct` and create a PR to GitHub repo
+  rubocop_challenger go --email=EMAIL --name=NAME  # Run `$ rubocop --autocorrect` and create a PR to GitHub repo
   rubocop_challenger help [COMMAND]                # Describe available commands or one specific command
   rubocop_challenger version                       # Show current version
 ```
@@ -122,10 +122,10 @@ Options:
                                                                  # Default: true
       [--offense-counts], [--no-offense-counts]                  # Include offense counts in .rubocop_todo.yml
                                                                  # Default: true
-      [--only-safe-auto-correct], [--no-only-safe-auto-correct]  # If given `true`, it executes `rubocop --auto-correct`,it means to correct safe cops only.
+      [--only-safe-autocorrect], [--no-only-safe-autocorrect]  # If given `true`, it executes `rubocop --autocorrect`,it means to correct safe cops only.
       [--verbose], [--no-verbose]                                # Displays executing command.
 
-Run `$ rubocop --auto-correct` and create a PR to GitHub repo
+Run `$ rubocop --autocorrect` and create a PR to GitHub repo
 ```
 
 ## Requirement

data/lib/rubocop_challenger/cli.rb

@@ -5,7 +5,7 @@ require 'thor'
 module RubocopChallenger
   # To define CLI commands
   class CLI < Thor
-    desc 'go', 'Run `$ rubocop --auto-correct` and create a PR to GitHub repo'
+    desc 'go', 'Run `$ rubocop --autocorrect` and create a PR to GitHub repo'
     option :email,
            required: true,
            type: :string,
@@ -65,10 +65,10 @@ module RubocopChallenger
            type: :boolean,
            default: true,
            desc: 'Include offense counts in .rubocop_todo.yml'
-    option :only_safe_auto_correct,
+    option :only_safe_autocorrect,
            type: :boolean,
            default: false,
-           desc: 'If given `true`, it executes `rubocop --auto-correct`,' \
+           desc: 'If given `true`, it executes `rubocop --autocorrect`,' \
                  'it means to correct safe cops only.'
     option :verbose,
            type: :boolean,

data/lib/rubocop_challenger/errors.rb

@@ -2,10 +2,10 @@
 
 module RubocopChallenger
   module Errors
-    # Raise if no auto-correctable rule in the `.rubocop_todo.yml`.
+    # Raise if no autocorrectable rule in the `.rubocop_todo.yml`.
     class NoAutoCorrectableRule < StandardError
       def initialize
-        super 'There is no auto-correctable rule'
+        super 'There is no autocorrectable rule'
       end
     end
   end

data/lib/rubocop_challenger/go.rb

@@ -11,8 +11,8 @@ module RubocopChallenger
     #   Include the date and time in .rubocop_todo.yml
     # @option offense_counts [Boolean]
     #   Include offense counts in .rubocop_todo.yml'
-    # @option only-safe-auto-correct [Boolean]
-    #   If given `true`, it executes `rubocop --auto-correct`,
+    # @option only-safe-autocorrect [Boolean]
+    #   If given `true`, it executes `rubocop --autocorrect`,
     #   it means to correct safe cops only.
     # @option name [String]
     #   The author name which use at the git commit
@@ -131,7 +131,7 @@ module RubocopChallenger
     end
 
     DESCRIPTION_THAT_CHALLENGE_IS_INCOMPLETE = <<~MSG
-      Rubocop Challenger has executed auto-correcting but it is incomplete.
+      Rubocop Challenger has executed autocorrecting but it is incomplete.
       Therefore the rule add to ignore list.
     MSG
 
@@ -141,7 +141,7 @@ module RubocopChallenger
     #
     # @param rule [Rubocop::Rule] The corrected rule
     def add_to_ignore_list_if_challenge_is_incomplete(rule)
-      return unless auto_correct_incomplete?(rule)
+      return unless autocorrect_incomplete?(rule)
 
       pull_request.commit! ':police_car: add the rule to the ignore list' do
         config_editor = Rubocop::ConfigEditor.new
@@ -156,7 +156,7 @@ module RubocopChallenger
     #
     # @param rule [Rubocop::Rule] The corrected rule
     # @return [Boolean] Return true if the challenge successed
-    def auto_correct_incomplete?(rule)
+    def autocorrect_incomplete?(rule)
       todo_reader = Rubocop::TodoReader.new(options[:file_path])
       todo_reader.all_rules.include?(rule)
     end
@@ -165,7 +165,7 @@ module RubocopChallenger
       {
         file_path: options[:file_path],
         mode: mode,
-        only_safe_auto_correct: options[:only_safe_auto_correct]
+        only_safe_autocorrect: options[:only_safe_autocorrect]
       }
     end
 

data/lib/rubocop_challenger/rubocop/challenge.rb

@@ -4,17 +4,17 @@ module RubocopChallenger
   module Rubocop
     # To execute Rubocop Challenge flow
     class Challenge
-      def self.exec(file_path:, mode:, only_safe_auto_correct:)
-        new(file_path, mode, only_safe_auto_correct).send(:exec)
+      def self.exec(file_path:, mode:, only_safe_autocorrect:)
+        new(file_path, mode, only_safe_autocorrect).send(:exec)
       end
 
       private
 
-      attr_reader :mode, :only_safe_auto_correct, :command, :todo_reader, :todo_writer
+      attr_reader :mode, :only_safe_autocorrect, :command, :todo_reader, :todo_writer
 
-      def initialize(file_path, mode, only_safe_auto_correct)
+      def initialize(file_path, mode, only_safe_autocorrect)
         @mode = mode
-        @only_safe_auto_correct = only_safe_auto_correct
+        @only_safe_autocorrect = only_safe_autocorrect
         @command = Rubocop::Command.new
         @todo_reader = Rubocop::TodoReader.new(file_path)
         @todo_writer = Rubocop::TodoWriter.new(file_path)
@@ -24,7 +24,7 @@ module RubocopChallenger
       def exec
         verify_target_rule
         todo_writer.delete_rule(target_rule)
-        command.auto_correct(only_safe_auto_correct: only_safe_auto_correct)
+        command.autocorrect(only_safe_autocorrect: only_safe_autocorrect)
         target_rule
       end
 

data/lib/rubocop_challenger/rubocop/command.rb

@@ -7,11 +7,11 @@ module RubocopChallenger
       include PrComet::CommandLine
 
       # Executes auto correction
-      def auto_correct(only_safe_auto_correct:)
-        if only_safe_auto_correct
-          run('--auto-correct')
+      def autocorrect(only_safe_autocorrect:)
+        if only_safe_autocorrect
+          run('-a') # --autocorrect     Autocorrect offenses (only when it's safe).
         else
-          run('--auto-correct-all')
+          run('-A') # --autocorrect-all Autocorrect offenses (safe and unsafe).
         end
       end
 

data/lib/rubocop_challenger/rubocop/rule.rb

@@ -26,9 +26,10 @@ module RubocopChallenger
         offense_count <=> other.offense_count
       end
 
-      def auto_correctable?
-        contents.include?('# Cop supports --auto-correct') || # for rubocop < v1.26.0
-          contents.match?(/# This cop supports (un)?safe auto-correction/) # for rubocop >= v1.26.0
+      def autocorrectable?
+        contents.match?('# This cop supports (un)?safe autocorrection') || # for rubocop >= v1.30.0
+          contents.match?(/# This cop supports (un)?safe auto-correction/) || # for rubocop >= v1.26.0
+          contents.include?('# Cop supports --auto-correct') # for rubocop < v1.26.0
       end
 
       def rubydoc_url

data/lib/rubocop_challenger/rubocop/todo_reader.rb

@@ -29,23 +29,23 @@ module RubocopChallenger
       end
 
       # @return [Array<Rule>]
-      def auto_correctable_rules
-        all_rules.select(&:auto_correctable?)
+      def autocorrectable_rules
+        all_rules.select(&:autocorrectable?)
       end
 
       # @return [Rule]
       def least_occurrence_rule
-        auto_correctable_rules.first
+        autocorrectable_rules.first
       end
 
       # @return [Rule]
       def most_occurrence_rule
-        auto_correctable_rules.last
+        autocorrectable_rules.last
       end
 
       # @return [Rule]
       def any_rule
-        auto_correctable_rules.sample
+        autocorrectable_rules.sample
       end
 
       private

data/lib/rubocop_challenger/rubocop/yardoc.rb

@@ -18,8 +18,8 @@ module RubocopChallenger
         yardoc.tags('example').map { |tag| [tag.name, tag.text] }
       end
 
-      # Indicates whether the auto-correct a cop does is safe (equivalent) by design.
-      # If a cop is unsafe its auto-correct automatically becomes unsafe as well.
+      # Indicates whether the autocorrect a cop does is safe (equivalent) by design.
+      # If a cop is unsafe its autocorrect automatically becomes unsafe as well.
       #
       # @return [Boolean]
       def safe_autocorrect?

data/lib/rubocop_challenger/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RubocopChallenger
-  VERSION = '2.8.0'
+  VERSION = '2.9.0'
 end

data/lib/templates/checklist.md.erb

@@ -4,10 +4,10 @@
 
 <% if safe_autocorrect? -%>
 **Safe autocorrect: Yes**
-:white_check_mark: The auto-correct a cop does is safe (equivalent) by design.
+:white_check_mark: The autocorrect a cop does is safe (equivalent) by design.
 <% else -%>
 **Safe autocorrect: No**
-:warning: The auto-correct a cop can yield false positives by design.
+:warning: The autocorrect a cop can yield false positives by design.
 <% end -%>
 
 ## Description

data/lib/templates/default.md.erb

@@ -4,10 +4,10 @@
 
 <% if safe_autocorrect? -%>
 **Safe autocorrect: Yes**
-:white_check_mark: The auto-correct a cop does is safe (equivalent) by design.
+:white_check_mark: The autocorrect a cop does is safe (equivalent) by design.
 <% else -%>
 **Safe autocorrect: No**
-:warning: The auto-correct a cop can yield false positives by design.
+:warning: The autocorrect a cop can yield false positives by design.
 <% end -%>
 
 ## Description

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop_challenger
 version: !ruby/object:Gem::Version
-  version: 2.8.0
+  version: 2.9.0
 platform: ruby
 authors:
 - ryosuke_sato
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-05-30 00:00:00.000000000 Z
+date: 2022-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pr_comet