rubocop_challenger 1.2.0 → 2.0.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca4060e23f09a0c2a36203f0ce089fe50c91d789ba6ed19a108633ee5f874048
-  data.tar.gz: cd0fd5ab050e01188cf86513734ba468c754cda0dcf946315fb51766e60bc2f9
+  metadata.gz: 88964a115a552a48b7462b24e329661fe2254f14e83a0effb9ce3cdf088d3abb
+  data.tar.gz: 81dbae9e07d6c9b51bea98db1f14196431563420b7c22a61a4e98b3b10559647
 SHA512:
-  metadata.gz: a67157938b07fa52da89dbcbc3ef4dbcdd244207131dbe7dbcca31823c13de13d98810380a99e61c96f1535c873ee20265eb0e28a0d408780334235887c3a6b4
-  data.tar.gz: 3d1fa7adc9d4cb3b6516faf6aebced9609098e69275fb92dbce0af7589a0edb7b308d9f8e4209f2f869d0a708f89b5c36c58c98298d392a08a420b438118d6f0
+  metadata.gz: 4ba31abab9fc1f3a6446db04e6e05490896be15e6916682deb8dcf49d784c021e4e7fd72fb96f17e8f0b004a4baaf1884308e75670ebab38c2115461c17b7686
+  data.tar.gz: 20bc09b991dda4c2cb7c2868527673409baff908c4712afb505152b78dc46fb8227bde6a65814217d8b0075a24cfc0be31a836dc7987e48d7979164d5be3250f

data/.circleci/config.yml

@@ -82,10 +82,6 @@ references:
           destination: yardoc
 
 jobs:
-  build_on_ruby_2.3:
-    docker:
-       - image: circleci/ruby:2.3-node-browsers
-    <<: *build
   build_on_ruby_2.4:
     docker:
        - image: circleci/ruby:2.4-node-browsers
@@ -104,15 +100,15 @@ jobs:
     <<: *build
   rubocop:
     docker:
-       - image: circleci/ruby:2.3-node-browsers
+       - image: circleci/ruby:2.4-node-browsers
     <<: *rubocop
   yardoc:
     docker:
-       - image: circleci/ruby:2.3-node-browsers
+       - image: circleci/ruby:2.4-node-browsers
     <<: *yardoc
   verify_rubocop_challenge:
     docker:
-      - image: circleci/ruby:2.3-node-browsers
+      - image: circleci/ruby:2.4-node-browsers
     working_directory: ~/repo
     steps:
       - checkout
@@ -134,12 +130,11 @@ jobs:
               --email=ryz310@gmail.com \
               --name=ryz310 \
               --mode=random \
-              --labels='rubocop challenge' 'in progress' \
-              --no-commit
+              --no-create-pr
 
   rubocop_challenge:
     docker:
-      - image: circleci/ruby:2.3-node-browsers
+      - image: circleci/ruby:2.4-node-browsers
     working_directory: ~/repo
     steps:
       - checkout
@@ -150,12 +145,11 @@ jobs:
             bundle exec rubocop_challenger go \
               --email=ryz310@gmail.com \
               --name=ryz310 \
-              --template=./lib/templates/checklist.md.erb \
-              --labels='rubocop challenge' 'in progress'
+              --template=./lib/templates/checklist.md.erb
 
   release:
     docker:
-       - image: circleci/ruby:2.3-node-browsers
+       - image: circleci/ruby:2.4-node-browsers
     working_directory: ~/repo
     steps:
       - checkout
@@ -179,7 +173,6 @@ workflows:
 
   commit:
     jobs:
-      - build_on_ruby_2.3
       - build_on_ruby_2.4
       - build_on_ruby_2.5
       - build_on_ruby_2.6
@@ -190,7 +183,6 @@ workflows:
       - release:
           context: RubyGems API Key
           requires:
-            - build_on_ruby_2.3
             - build_on_ruby_2.4
             - build_on_ruby_2.5
             - build_on_ruby_2.6

data/.rubocop.yml

@@ -3,7 +3,7 @@ require: rubocop-rspec
 inherit_from: .rubocop_todo.yml
 
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.4
 
 Metrics/BlockLength:
   Exclude:
@@ -13,3 +13,6 @@ Metrics/BlockLength:
 RSpec/MultipleExpectations:
   Exclude:
     - 'spec/rubocop_challenger/cli_spec.rb'
+
+RSpec/NestedGroups:
+  Max: 4

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2019-02-27 22:11:30 +0900 using RuboCop version 0.65.0.
+# on 2019-03-31 02:56:49 +0900 using RuboCop version 0.66.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rubocop_challenger (1.2.0)
+    rubocop_challenger (2.0.0.pre)
       octokit
       rubocop
       rubocop-rspec
@@ -14,7 +14,7 @@ GEM
     addressable (2.5.2)
       public_suffix (>= 2.0.2, < 4.0)
     ast (2.4.0)
-    byebug (11.0.0)
+    byebug (11.0.1)
     coderay (1.1.2)
     diff-lcs (1.3)
     docile (1.3.1)
@@ -24,12 +24,11 @@ GEM
     json (2.2.0)
     method_source (0.9.2)
     multipart-post (2.0.0)
-    octokit (4.13.0)
+    octokit (4.14.0)
       sawyer (~> 0.8.0, >= 0.5.3)
-    parallel (1.14.0)
-    parser (2.6.0.0)
+    parallel (1.16.2)
+    parser (2.6.2.0)
       ast (~> 2.4.0)
-    powerpack (0.1.2)
     pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
@@ -55,15 +54,14 @@ GEM
     rspec-support (3.8.0)
     rspec_junit_formatter (0.4.1)
       rspec-core (>= 2, < 4, != 2.12.0)
-    rubocop (0.65.0)
+    rubocop (0.66.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
       parser (>= 2.5, != 2.5.1.1)
-      powerpack (~> 0.1)
       psych (>= 3.1.0)
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.4.0)
+      unicode-display_width (>= 1.4.0, < 1.6)
     rubocop-rspec (1.32.0)
       rubocop (>= 0.60.0)
     ruby-progressbar (1.10.0)
@@ -76,7 +74,7 @@ GEM
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
     thor (0.20.3)
-    unicode-display_width (1.4.1)
+    unicode-display_width (1.5.0)
     yard (0.9.18)
 
 PLATFORMS

data/README.md

@@ -1,6 +1,6 @@
 # Rubocop Challenger
 
-[![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) [![Waffle.io - Columns and their card count](https://badge.waffle.io/ryz310/rubocop_challenger.svg?columns=all)](https://waffle.io/ryz310/rubocop_challenger)
+[![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.
@@ -19,7 +19,9 @@ I call such work *Rubocop Challenge*. And the *RubocopChallenger* is a gem to su
 
 ### 1. Edit your Gemfile
 
-Put this line in your Gemfile.
+If you do not specify the version of `rubocop` gem so you do not have to add `rubocop_challenger` gem in your Gemfile (**Recommended**).
+
+If you specify the version so put this line in your Gemfile.
 
 ```rb
 gem 'rubocop_challenger', group: :development, require: false
@@ -53,8 +55,8 @@ jobs:
       - run:
           name: Rubocop Challenge
           command: |
-            bundle install
-            bundle exec rubocop_challenger go \
+            gem install rubocop_challenger
+            rubocop_challenger go \
               --email=rubocop-challenger@example.com \
               --name="Rubocop Challenger"
 
@@ -73,13 +75,27 @@ workflows:
       - rubocop_challenge
 ```
 
+If you added `rubocop_challenger` gem in your Gemfile so please modify script of installing and execution as following:
+
+```yml
+steps:
+  - checkout
+  - run:
+      name: Rubocop Challenge
+      command: |
+        bundle install
+        bundle exec rubocop_challenger go \
+          --email=rubocop-challenger@example.com \
+          --name="Rubocop Challenger"
+```
+
 ## CLI command references
 
 ```sh
 $ rubocop_challenger help
 
 Commands:
-  rubocop_challenger go --email=EMAIL --name=NAME  # Run `$ rubocop --auto-correct` and create PR to GitHub repo
+  rubocop_challenger go --email=EMAIL --name=NAME  # Run `$ rubocop --auto-correct` and create a PR to GitHub repo
   rubocop_challenger help [COMMAND]                # Describe available commands or one specific command
   rubocop_challenger version                       # Show current version
 ```
@@ -93,26 +109,23 @@ Usage:
   rubocop_challenger go --email=EMAIL --name=NAME
 
 Options:
-      --email=EMAIL                                                # Pull Request committer email
-      --name=NAME                                                  # Pull Request committer name
-  f, [--file-path=FILE_PATH]                                       # Set your ".rubocop_todo.yml" path
-                                                                   # Default: .rubocop_todo.yml
-  t, [--template=TEMPLATE]                                         # Pull Request template `erb` file path.You can use variable that `title`, `rubydoc_url`, `description` and `examples` into the erb file.
-      [--mode=MODE]                                                # Mode to select deletion target. You can choice "most_occurrence", "least_occurrence", or "random"
-                                                                   # Default: most_occurrence
-      [--base=BASE]                                                # Base branch of Pull Request
-                                                                   # Default: master
-  l, [--labels=one two three]                                      # Label to give to Pull Request
-                                                                   # Default: ["rubocop challenge"]
-      [--no-commit]                                                # No commit after autocorrect
-
-Run `$ rubocop --auto-correct` and create PR to GitHub repo
+      --email=EMAIL            # The Pull Request committer email
+      --name=NAME              # The Pull Request committer name
+  f, [--file-path=FILE_PATH]   # Set your ".rubocop_todo.yml" path
+                               # Default: .rubocop_todo.yml
+  t, [--template=TEMPLATE]     # A Pull Request template `erb` file path.You can use variable that `title`, `rubydoc_url`, `description` and `examples` into the erb file.
+      [--mode=MODE]            # Mode to select deletion target. You can choice "most_occurrence", "least_occurrence", or "random"
+                               # Default: most_occurrence
+  l, [--labels=one two three]  # Label to give to Pull Request
+                               # Default: ["rubocop challenge"]
+      [--no-create-pr]         # No create a pull request (for testing)
+
+Run `$ rubocop --auto-correct` and create a PR to GitHub repo
 ```
 
 ## Requirement
 
-* Ruby 2.3 or higher
-    * NOTE: Ruby 2.3 will EOL soon (See: [Ruby Maintenance Branches](https://www.ruby-lang.org/en/downloads/branches/))
+* Ruby 2.4 or higher
 
 ## Development
 

data/bin/create_release_pr

@@ -6,20 +6,17 @@
 require 'bundler/setup'
 require 'rubocop_challenger'
 
-def exit_process(error_message)
-  puts error_message
-  exit!
-end
-
 VERSION_FORMAT = /\A\d+\.\d+\.\d+(\.(pre|beta|rc)\d?)?\z/.freeze
 version = ARGV[0]
 rubocop = RubocopChallenger::Rubocop::Command.new
 pr_creater =
-  RubocopChallenger::Github::PrCreater.new(branch: "update/v#{version}")
+  RubocopChallenger::Github::PrCreater.new(
+    base: 'master', branch: "update/v#{version}"
+  )
 
 # Verifying
-exit_process 'usage: bin/create_release_pr VERSION' if version.nil?
-exit_process 'A version must be like a `1.2.3`' unless version =~ VERSION_FORMAT
+abort 'usage: bin/create_release_pr VERSION' if version.nil?
+abort 'A version must be like a `1.2.3`' unless version =~ VERSION_FORMAT
 
 # Modify a version file
 pr_creater.commit 'Update version' do
@@ -43,4 +40,4 @@ pr_creater.commit 'Regenerate .rubocop_todo.yml' do
 end
 
 # Create PR
-pr_creater.create_pr(title: "Update v#{version}", body: '', base: 'master')
+pr_creater.create_pr(title: "Update v#{version}", body: '')

data/lib/rubocop_challenger/bundler/command.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module RubocopChallenger
+  module Bundler
+    # To execute bundler command
+    class Command
+      include CommandLine
+
+      def update(*gem_names)
+        run('update', *gem_names)
+      end
+
+      def installed?(gem_name)
+        !run('list', '|', 'grep', gem_name).empty?
+      end
+
+      private
+
+      def run(*subcommands)
+        command = "bundle #{subcommands.join(' ')}"
+        execute(command)
+      end
+    end
+  end
+end

data/lib/rubocop_challenger/cli.rb

@@ -32,19 +32,15 @@ module RubocopChallenger
            default: 'most_occurrence',
            desc: 'Mode to select deletion target. You can choice ' \
                  '"most_occurrence", "least_occurrence", or "random"'
-    option :base,
-           type: :string,
-           default: 'master',
-           desc: 'Base branch of Pull Request'
     option :labels,
            type: :array,
            default: ['rubocop challenge'],
            aliases: :l,
            desc: 'Label to give to Pull Request'
-    option :'no-commit',
+    option :'no-create-pr',
            type: :boolean,
            default: false,
-           desc: 'No commit after autocorrect'
+           desc: 'No create a pull request (for testing)'
     def go
       Go.new(options).exec
     rescue Errors::NoAutoCorrectableRule => e
@@ -61,17 +57,15 @@ module RubocopChallenger
 
     # Workaround to return exit code 1 when an error occurs
     # @see https://github.com/erikhuda/thor/issues/244
-    module ClassMethods
-      def exit_on_failure?
-        true
-      end
+    def self.exit_on_failure?
+      true
     end
 
     private
 
     # Exit process (Mainly for mock when testing)
     def exit_process!
-      exit!
+      abort
     end
   end
 end

data/lib/rubocop_challenger/github/pr_creater.rb

@@ -7,13 +7,15 @@ module RubocopChallenger
       # Returns a new instance of Github::PrCreater
       #
       # @note You have to set ENV['GITHUB_ACCESS_TOKEN']
+      # @param base [String] The branch you want your changes pulled into
       # @param branch [String] The branch where your changes are going to
       #                        implement.
       # @param user_name [String] The username to use for committer and author
       # @param user_email [String] The email to use for committer and author
-      def initialize(branch:, user_name: nil, user_email: nil)
+      def initialize(base:, branch:, user_name: nil, user_email: nil)
         raise "You have to set ENV['GITHUB_ACCESS_TOKEN']" if access_token.nil?
 
+        @base_branch = base
         @topic_branch = branch
         @git = Git::Command.new(user_name: user_name, user_email: user_email)
         @github = Github::Client.new(access_token, git.remote_url('origin'))
@@ -40,36 +42,22 @@ module RubocopChallenger
       #
       # @param title [String] Title for the pull request
       # @param body [String] The body for the pull request
-      # @param base [String] The branch you want your changes pulled into
       # @param labels [Array<String>] An array of labels to apply to this PR
       # @return [Boolean] Return true if its successed
-      def create_pr(title:, body:, base:, labels: nil)
+      def create_pr(title:, body:, labels: nil)
         return false unless git_condition_valid?
 
         git.push(github_token_url, topic_branch)
         pr_number = github.create_pull_request(
-          base: base, head: topic_branch, title: title, body: body
+          base: base_branch, head: topic_branch, title: title, body: body
         )
         github.add_labels(pr_number, *labels) unless labels.nil?
         true
       end
 
-      # Stubing each PrCreater methods for testing
-      class Mock
-        def initialize(*); end
-
-        def commit(*)
-          yield if block_given?
-        end
-
-        def create_pr(*)
-          true
-        end
-      end
-
       private
 
-      attr_reader :git, :github, :topic_branch, :initial_sha1
+      attr_reader :git, :github, :base_branch, :topic_branch, :initial_sha1
 
       def git_condition_valid?
         !git.current_sha1?(initial_sha1) && git.current_branch?(topic_branch)

data/lib/rubocop_challenger/github/pr_template.rb

@@ -11,7 +11,7 @@ module RubocopChallenger
         @yardoc = Rubocop::Yardoc.new(title)
       end
 
-      def generate_pullrequest_markdown
+      def generate
         <<~TEMPLATE
           #{ERB.new(template, nil, '-').result(binding)}
           Auto generated by [rubocop_challenger](https://github.com/ryz310/rubocop_challenger)

data/lib/rubocop_challenger/go.rb

@@ -8,104 +8,135 @@ module RubocopChallenger
     # @param options [Hash] describe_options_here
     def initialize(options)
       @options = options
+      @pull_request = PullRequest.new(
+        options[:name],
+        options[:email],
+        options[:labels],
+        options[:'no-create-pr']
+      )
     end
 
+    # Executes Rubocop Challenge flow
+    #
     # @raise [Errors::NoAutoCorrectableRule]
+    #   Raises if there is no auto correctable rule in ".rubocop_todo.yml"
     def exec
+      update_rubocop!
+      before_version, after_version = regenerate_rubocop_todo!
+      corrected_rule = rubocop_challenge!(before_version, after_version)
       regenerate_rubocop_todo!
-      corrected_rule = rubocop_challenge!
-      regenerate_rubocop_todo!
-      if auto_correct_incomplete?(corrected_rule)
-        add_ignore_list!(corrected_rule)
-      end
+      add_to_ignore_list_if_challenge_is_incomplete(corrected_rule)
       create_pull_request!(corrected_rule)
     end
 
     private
 
-    attr_reader :options
+    attr_reader :options, :pull_request
+
+    def update_rubocop!
+      bundler = Bundler::Command.new
+      pull_request.commit! ':police_car: $ bundle update rubocop' do
+        bundler.update 'rubocop'
+        bundler.update 'rubocop-rspec' if bundler.installed?('rubocop-rspec')
+      end
+    end
 
     # Re-generate .rubocop_todo.yml and run git commit.
+    #
+    # @return [Array<String>]
+    #  Returns the versions of RuboCop which created ".rubocop_todo.yml" before
+    #  and after re-generate.
     def regenerate_rubocop_todo!
-      pr_creater.commit ':police_car: regenerate rubocop todo' do
+      before_version = scan_rubocop_version_in_rubocop_todo_file
+      pull_request.commit! ':police_car: regenerate rubocop todo' do
         Rubocop::Command.new.auto_gen_config
       end
+      after_version = scan_rubocop_version_in_rubocop_todo_file
+
+      [before_version, after_version]
+    end
+
+    # @return [String] The version of RuboCop which created ".rubocop_todo.yml"
+    def scan_rubocop_version_in_rubocop_todo_file
+      Rubocop::TodoReader.new(options[:file_path]).version
     end
 
     # Run rubocop challenge.
     #
-    # @return [Rubocop::Rule] The corrected rule
-    def rubocop_challenge!
-      corrected_rule =
-        Rubocop::Challenge.exec(options[:file_path], options[:mode])
-      pr_creater.commit ":police_car: #{corrected_rule.title}"
-      corrected_rule
+    # @param before_version [String]
+    #   The version of RuboCop which created ".rubocop_todo.yml" before
+    #   re-generate.
+    # @param after_version [String]
+    #   The version of RuboCop which created ".rubocop_todo.yml" after
+    #   re-generate
+    # @return [Rubocop::Rule]
+    #   The corrected rule
+    # @raise [Errors::NoAutoCorrectableRule]
+    #   Raises if there is no auto correctable rule in ".rubocop_todo.yml"
+    def rubocop_challenge!(before_version, after_version)
+      Rubocop::Challenge.exec(options[:file_path], options[:mode]).tap do |rule|
+        pull_request.commit! ":police_car: #{rule.title}"
+      end
+    rescue Errors::NoAutoCorrectableRule => e
+      create_another_pull_request!(before_version, after_version)
+      raise e
     end
 
-    # GitHub PR creater instance.
-    def pr_creater
-      @pr_creater ||= Github::PrCreater.new(
-        branch: "rubocop-challenge/#{timestamp}",
-        user_name: options[:name],
-        user_email: options[:email]
+    # Creates a pull request for the Rubocop Challenge
+    #
+    # @param corrected_rule [Rubocop::Rule] The corrected rule
+    def create_pull_request!(corrected_rule)
+      pull_request.create_rubocop_challenge_pr!(
+        corrected_rule, options[:template]
       )
     end
 
-    # Check the challenge result. When the challenge successed, the rule dose
-    # not exist in the .rubocop_todo.yml after regenerate it too.
+    # Creates a pull request which re-generate ".rubocop_todo.yml" with new
+    # version RuboCop. Use this method if it does not need to make a challenge
+    # but ".rubocop_todo.yml" is out of date. If same both `before_version` and
+    # `after_version`, it does not work.
     #
-    # @param rule [Rubocop::Rule] The target rule
-    # @return [Boolean] Return true if the challenge successed
-    def auto_correct_incomplete?(rule)
-      todo_reader = Rubocop::TodoReader.new(options[:file_path])
-      todo_reader.all_rules.include?(rule)
+    # @param before_version [String]
+    #   The version of RuboCop which created ".rubocop_todo.yml" before
+    #   re-generate.
+    # @param after_version [String]
+    #   The version of RuboCop which created ".rubocop_todo.yml" after
+    #   re-generate
+    def create_another_pull_request!(before_version, after_version)
+      return if before_version == after_version
+
+      pull_request.create_regenerate_todo_pr!(before_version, after_version)
     end
 
-    # If still exist the rule, the rule regard as cannot correct automatically
-    # then add to ignore list and it is not chosen as target rule from next
-    # time.
+    DESCRIPTION_THAT_CHALLENGE_IS_INCOMPLETE = <<~MSG
+      Rubocop Challenger has executed auto-correcting but it is incomplete.
+      Therefore the rule add to ignore list.
+    MSG
+
+    # If still exist the rule after a challenge, the rule regard as cannot
+    # correct automatically then add to ignore list and it is not chosen as
+    # target rule from next time.
     #
-    # @param rule [Rubocop::Rule] The target rule
-    def add_ignore_list!(rule)
-      pr_creater.commit ':police_car: add the rule to the ignore list' do
+    # @param rule [Rubocop::Rule] The corrected rule
+    def add_to_ignore_list_if_challenge_is_incomplete(rule)
+      return unless auto_correct_incomplete?(rule)
+
+      pull_request.commit! ':police_car: add the rule to the ignore list' do
         config_editor = Rubocop::ConfigEditor.new
         config_editor.add_ignore(rule)
         config_editor.save
       end
-      message = <<~MSG
-        Rubocop Challenger has executed auto-correcting but it is incomplete.
-        Therefore the rule add to ignore list.
-      MSG
-      color_puts message, CommandLine::YELLOW
+      color_puts DESCRIPTION_THAT_CHALLENGE_IS_INCOMPLETE, CommandLine::YELLOW
     end
 
-    # Create a PR with description of what modification were made.
+    # Checks the challenge result. If the challenge is successed, the rule
+    # should not exist in the ".rubocop_todo.yml" after regenerate.
     #
-    # @param rule [Rubocop::Rule] The target rule
-    def create_pull_request!(rule)
-      pr_creater_options = generate_pr_creater_options(rule)
-      return if options[:'no-commit']
-
-      pr_creater.create_pr(pr_creater_options)
-    end
-
-    def generate_pr_creater_options(rule)
-      {
-        title: "#{rule.title}-#{timestamp}",
-        body: generate_pr_body(rule),
-        base: options[:base],
-        labels: options[:labels]
-      }
-    end
-
-    def generate_pr_body(rule)
-      Github::PrTemplate
-        .new(rule, options[:template])
-        .generate_pullrequest_markdown
-    end
-
-    def timestamp
-      @timestamp ||= Time.now.strftime('%Y%m%d%H%M%S')
+    # @param rule [Rubocop::Rule] The corrected rule
+    # @return [Boolean] Return true if the challenge successed
+    def auto_correct_incomplete?(rule)
+      todo_reader = Rubocop::TodoReader.new(options[:file_path])
+      todo_reader.all_rules.include?(rule)
     end
   end
 end

data/lib/rubocop_challenger/pull_request.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module RubocopChallenger
+  # Creates a pull request
+  class PullRequest
+    # @param user_name [String]
+    #   The author name which use at the git commit
+    # @param user_email [String]
+    #   The email address which use at the git commit
+    # @param labels [Array<String>]
+    #   Will create a pull request with the labels
+    # @param dry_run [Boolean]
+    #   Does not create a pull request when given `true`
+    def initialize(user_name, user_email, labels, dry_run = false)
+      @pr_creater = Github::PrCreater.new(
+        base: 'master',
+        branch: "rubocop-challenge/#{timestamp}",
+        user_name: user_name,
+        user_email: user_email
+      )
+      @labels = labels
+      @dry_run = dry_run
+    end
+
+    # Add and commit local files to the pull request
+    #
+    # @param message [String] The commit message
+    # @yield Some commands where modify local files
+    # @return [Object] Return result of yield if you use &block
+    def commit!(message, &block)
+      pr_creater.commit message, &block
+    end
+
+    # Creates a pull request for the Rubocop Challenge
+    #
+    # @param rule [Rubocop::Rule]
+    #   The corrected rule
+    # @param template_file_path [String, nil]
+    #   The template file name which use to generate the pull request body
+    # @return [Boolean]
+    #   Return true if its successed
+    def create_rubocop_challenge_pr!(rule, template_file_path = nil)
+      create_pull_request!(
+        title: "#{rule.title}-#{timestamp}",
+        body: Github::PrTemplate.new(rule, template_file_path).generate,
+        labels: labels
+      )
+    end
+
+    # Creates a pull request which re-generate ".rubocop_todo.yml" with new
+    # version RuboCop.
+    #
+    # @param before_version [String]
+    #   The version of RuboCop which created ".rubocop_todo.yml" before
+    #   re-generate.
+    # @param after_version [String]
+    #   The version of RuboCop which created ".rubocop_todo.yml" after
+    #   re-generate
+    # @return [Boolean]
+    #   Return true if its successed
+    def create_regenerate_todo_pr!(before_version, after_version)
+      create_pull_request!(
+        title: "Re-generate .rubocop_todo.yml with RuboCop v#{after_version}",
+        body: generate_pull_request_body(before_version, after_version),
+        labels: labels
+      )
+    end
+
+    private
+
+    attr_reader :pr_creater, :labels, :dry_run
+
+    # Create a PR with description of what modification were made.
+    def create_pull_request!(pr_creater_options)
+      pr_creater.create_pr(pr_creater_options) unless dry_run
+    end
+
+    def generate_pull_request_body(before_version, after_version)
+      <<~MARKDOWN
+        Re-generated the .rubocop_todo.yml because it was generated by old version RuboCop.
+
+        * Using RuboCop version: `#{before_version}` -> `#{after_version}`
+
+        Auto generated by [rubocop_challenger](https://github.com/ryz310/rubocop_challenger)
+      MARKDOWN
+    end
+
+    def timestamp
+      @timestamp ||= Time.now.strftime('%Y%m%d%H%M%S')
+    end
+  end
+end

data/lib/rubocop_challenger/rubocop/todo_reader.rb

@@ -8,22 +8,41 @@ module RubocopChallenger
         @rubocop_todo_file_path = rubocop_todo_file_path
       end
 
+      # Returns the version of RuboCop used to create the ".rubocop_todo.yml"
+      #
+      # @return [Type] the RuboCop version
+      def version
+        file_contents =~ /using RuboCop version (\d{1,}\.\d{1,}\.\d{1,})/
+        Regexp.last_match(1)
+      end
+
+      # @return [Array<Rule>]
+      #   Array of rubocop rule instances which ordered by offense count
       def all_rules
-        @all_rules ||= extract_rubocop_rules
+        @all_rules ||=
+          file_contents
+          .split(/\n{2,}/)
+          .map! { |content| Rule.new(content) }
+          .reject! { |rule| invalid?(rule) }
+          .sort!
       end
 
+      # @return [Array<Rule>]
       def auto_correctable_rules
         all_rules.select(&:auto_correctable?)
       end
 
+      # @return [Rule]
       def least_occurrence_rule
         auto_correctable_rules.first
       end
 
+      # @return [Rule]
       def most_occurrence_rule
         auto_correctable_rules.last
       end
 
+      # @return [Rule]
       def any_rule
         auto_correctable_rules.sample
       end
@@ -32,19 +51,18 @@ module RubocopChallenger
 
       attr_reader :rubocop_todo_file_path
 
-      def extract_rubocop_rules
-        File
-          .read(rubocop_todo_file_path)
-          .split(/\n{2,}/)
-          .map! { |content| Rule.new(content) }
-          .reject! { |rule| invalid?(rule) }
-          .sort!
+      # @return [String] the ".rubocop_todo.yml" contents
+      def file_contents
+        @file_contents ||= File.read(rubocop_todo_file_path)
       end
 
+      # @param rule [Rule] the target rule
+      # @return [Boolean]
       def invalid?(rule)
         rule.offense_count.zero? || ignored_rules.include?(rule.title)
       end
 
+      # @return [Array<String>] Ignored rule titles
       def ignored_rules
         @ignored_rules ||= ConfigEditor.new.ignored_rules
       end

data/lib/rubocop_challenger/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RubocopChallenger
-  VERSION = '1.2.0'
+  VERSION = '2.0.0.pre'
 end

data/lib/rubocop_challenger.rb

@@ -15,8 +15,10 @@ require 'rubocop_challenger/rubocop/todo_writer'
 require 'rubocop_challenger/rubocop/command'
 require 'rubocop_challenger/rubocop/challenge'
 require 'rubocop_challenger/rubocop/yardoc'
+require 'rubocop_challenger/pull_request'
 require 'rubocop_challenger/go'
 require 'rubocop_challenger/cli'
+require 'rubocop_challenger/bundler/command'
 require 'rubocop_challenger/git/command'
 require 'rubocop_challenger/github/client'
 require 'rubocop_challenger/github/pr_template'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop_challenger
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.0.0.pre
 platform: ruby
 authors:
 - ryosuke_sato
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-27 00:00:00.000000000 Z
+date: 2019-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: octokit
@@ -194,6 +194,7 @@ files:
 - images/generate_token.png
 - images/rubocop_challenge.png
 - lib/rubocop_challenger.rb
+- lib/rubocop_challenger/bundler/command.rb
 - lib/rubocop_challenger/cli.rb
 - lib/rubocop_challenger/command_line.rb
 - lib/rubocop_challenger/errors.rb
@@ -202,6 +203,7 @@ files:
 - lib/rubocop_challenger/github/pr_creater.rb
 - lib/rubocop_challenger/github/pr_template.rb
 - lib/rubocop_challenger/go.rb
+- lib/rubocop_challenger/pull_request.rb
 - lib/rubocop_challenger/rubocop/challenge.rb
 - lib/rubocop_challenger/rubocop/command.rb
 - lib/rubocop_challenger/rubocop/config_editor.rb
@@ -228,11 +230,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Make a clean your rubocop_todo.yml with CI