rubocop_challenger 2.0.0.pre10 → 2.3.0

data/Gemfile.lock

@@ -1,11 +1,13 @@
 PATH
   remote: .
   specs:
-    rubocop_challenger (2.0.0.pre10)
-      pr_comet (>= 0.2, < 0.4)
+    rubocop_challenger (2.3.0)
+      pr_comet (~> 0.5.1)
       rainbow
-      rubocop
+      rubocop (>= 0.87)
       rubocop-performance
+      rubocop-rails
+      rubocop-rake
       rubocop-rspec
       thor
       yard
@@ -13,86 +15,118 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (6.1.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
-    ast (2.4.0)
-    byebug (11.0.1)
-    coderay (1.1.2)
-    diff-lcs (1.3)
-    docile (1.3.2)
-    faraday (0.17.0)
+    ast (2.4.2)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.8)
+    diff-lcs (1.4.4)
+    docile (1.3.5)
+    faraday (1.3.0)
+      faraday-net_http (~> 1.0)
       multipart-post (>= 1.2, < 3)
-    jaro_winkler (1.5.3)
-    json (2.2.0)
-    method_source (0.9.2)
+      ruby2_keywords
+    faraday-net_http (1.0.1)
+    i18n (1.8.9)
+      concurrent-ruby (~> 1.0)
+    method_source (1.0.0)
+    minitest (5.14.3)
     multipart-post (2.1.1)
-    octokit (4.14.0)
+    octokit (4.20.0)
+      faraday (>= 0.9)
       sawyer (~> 0.8.0, >= 0.5.3)
-    parallel (1.18.0)
-    parser (2.6.5.0)
-      ast (~> 2.4.0)
-    pr_comet (0.3.0)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    pr_comet (0.5.1)
       octokit
       rainbow
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    pry-byebug (3.7.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
       byebug (~> 11.0)
-      pry (~> 0.10)
-    public_suffix (4.0.1)
+      pry (~> 0.13.0)
+    public_suffix (4.0.6)
+    rack (2.2.3)
     rainbow (3.0.0)
-    rake (13.0.0)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.0)
-      rspec-support (~> 3.9.0)
-    rspec-expectations (3.9.0)
+    rake (13.0.3)
+    regexp_parser (2.1.0)
+    rexml (3.2.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
     rspec_junit_formatter (0.4.1)
       rspec-core (>= 2, < 4, != 2.12.0)
-    rubocop (0.75.1)
-      jaro_winkler (~> 1.5.1)
+    rubocop (1.10.0)
       parallel (~> 1.10)
-      parser (>= 2.6)
+      parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
-    rubocop-performance (1.5.0)
-      rubocop (>= 0.71.0)
-    rubocop-rspec (1.36.0)
-      rubocop (>= 0.68.1)
-    ruby-progressbar (1.10.1)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    rubocop-performance (1.9.2)
+      rubocop (>= 0.90.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rails (2.9.1)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 0.90.0, < 2.0)
+    rubocop-rake (0.5.1)
+      rubocop
+    rubocop-rspec (2.2.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.4)
     sawyer (0.8.2)
       addressable (>= 2.3.5)
       faraday (> 0.8, < 2.0)
-    simplecov (0.17.1)
+    simplecov (0.21.2)
       docile (~> 1.1)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
-    thor (0.20.3)
-    unicode-display_width (1.6.0)
-    yard (0.9.20)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.2)
+    thor (1.1.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.0.0)
+    yard (0.9.26)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.16)
+  bundler (>= 2.0)
   pry-byebug
   rake (~> 13.0)
   rspec
   rspec_junit_formatter
   rubocop_challenger!
-  simplecov
+  simplecov (= 0.21.2)
 
 BUNDLED WITH
-   1.17.3
+   2.2.3

data/README.md

@@ -56,7 +56,7 @@ version: 2
 jobs:
   rubocop_challenge:
     docker:
-      - image: circleci/ruby:2.6-node-browsers
+      - image: circleci/ruby:3.0
     working_directory: ~/repo
     steps:
       - checkout
@@ -83,20 +83,6 @@ 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
@@ -117,30 +103,32 @@ Usage:
   rubocop_challenger go --email=EMAIL --name=NAME
 
 Options:
-      --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
-  b, [--base-branch=BASE_BRANCH]                         # The Branch to merge into
-                                                         # Default: master
-  l, [--labels=one two three]                            # Label to give to Pull Request
-                                                         # Default: ["rubocop challenge"]
-      [--project-column-name=PROJECT_COLUMN_NAME]        # A project column name. You can add the created PR to the GitHub project
-      [--project-id=N]                                   # A target project ID. If does not supplied, this method will find a project which associated the repository. When the repository has multiple projects, you should supply this.
-      [--no-create-pr]                                   # No create a pull request (for testing)
-      [--exclude-limit=N]                                # For how many exclude properties when creating the .rubocop_todo.yml
-      [--auto-gen-timestamp], [--no-auto-gen-timestamp]  # Include the date and time when creating the .rubocop_todo.yml
-                                                         # Default: true
+      --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
+  b, [--base-branch=BASE_BRANCH]                                 # The Branch to merge into
+                                                                 # Default: master
+  l, [--labels=one two three]                                    # Label to give to Pull Request
+                                                                 # Default: ["rubocop challenge"]
+      [--project-column-name=PROJECT_COLUMN_NAME]                # A project column name. You can add the created PR to the GitHub project
+      [--project-id=N]                                           # A target project ID. If does not supplied, this method will find a project which associated the repository. When the repository has multiple projects, you should supply this.
+      [--no-create-pr]                                           # No create a pull request (for testing)
+      [--exclude-limit=N]                                        # For how many exclude properties when creating the .rubocop_todo.yml
+      [--auto-gen-timestamp], [--no-auto-gen-timestamp]          # Include the date and time when creating the .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.
+      [--verbose], [--no-verbose]                                # Displays executing command.
 
 Run `$ rubocop --auto-correct` and create a PR to GitHub repo
 ```
 
 ## Requirement
 
-* Ruby 2.4 or higher
+* Ruby 2.5 or higher
 
 ## Development
 

data/challenger.gemspec

@@ -22,18 +22,22 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'pr_comet', '>= 0.2', '< 0.4'
+  spec.required_ruby_version = '>= 2.5'
+
+  spec.add_runtime_dependency 'pr_comet', '~> 0.5.1'
   spec.add_runtime_dependency 'rainbow'
-  spec.add_runtime_dependency 'rubocop'
+  spec.add_runtime_dependency 'rubocop', '>= 0.87'
   spec.add_runtime_dependency 'rubocop-performance'
+  spec.add_runtime_dependency 'rubocop-rails'
+  spec.add_runtime_dependency 'rubocop-rake'
   spec.add_runtime_dependency 'rubocop-rspec'
   spec.add_runtime_dependency 'thor'
   spec.add_runtime_dependency 'yard'
 
-  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'bundler', '>= 2.0'
   spec.add_development_dependency 'pry-byebug'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rspec_junit_formatter'
-  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'simplecov', '0.21.2'
 end

data/lib/rubocop_challenger.rb

@@ -24,6 +24,7 @@ module RubocopChallenger
     rubocop
     rubocop-performance
     rubocop-rails
+    rubocop-rake
     rubocop-rspec
   ].freeze
 end

data/lib/rubocop_challenger/bundler/command.rb

@@ -6,11 +6,15 @@ module RubocopChallenger
     class Command
       include PrComet::CommandLine
 
+      def initialize(verbose: false)
+        @verbose = verbose
+      end
+
       # Executes `$ bundle update` which excludes not installed gems
       #
       # @param gem_names [Array<String>] The target gem names
       def update(*gem_names)
-        run('update', *gem_names.select(&method(:installed?)))
+        run('update', *gem_names.select { |gem_name| installed?(gem_name) })
       end
 
       # Checks the gem is installed

data/lib/rubocop_challenger/cli.rb

@@ -61,6 +61,15 @@ module RubocopChallenger
            type: :boolean,
            default: true,
            desc: 'Include the date and time when creating the .rubocop_todo.yml'
+    option :'only-safe-auto-correct',
+           type: :boolean,
+           default: false,
+           desc: 'If given `true`, it executes `rubocop --auto-correct`,' \
+                 'it means to correct safe cops only.'
+    option :verbose,
+           type: :boolean,
+           default: false,
+           desc: 'Displays executing command.'
     def go
       Go.new(options).exec
     rescue Errors::NoAutoCorrectableRule => e

data/lib/rubocop_challenger/github/pr_template.rb

@@ -53,6 +53,10 @@ module RubocopChallenger
         yardoc.examples
       end
 
+      def safe_autocorrect?
+        yardoc.safe_autocorrect?
+      end
+
       def yardoc
         @yardoc ||= Rubocop::Yardoc.new(title)
       end

data/lib/rubocop_challenger/go.rb

@@ -9,6 +9,9 @@ module RubocopChallenger
     #   For how many exclude properties when creating the ".rubocop_todo.yml"
     # @option auto-gen-timestamp [Boolean]
     #   Include the date and time when creating the ".rubocop_todo.yml"
+    # @option only-safe-auto-correct [Boolean]
+    #   If given `true`, it executes `rubocop --auto-correct`,
+    #   it means to correct safe cops only.
     # @option name [String]
     #   The author name which use at the git commit
     # @option email [String]
@@ -23,11 +26,10 @@ module RubocopChallenger
     #   A target project ID. If does not supplied, this method will find a
     #   project which associated the repository. When the repository has
     #   multiple projects, you should supply this.
+    # @option verbose [Boolean]
+    #   Displays executing command.
     def initialize(options)
       @options = options
-      @exclude_limit = options[:'exclude-limit']
-      @auto_gen_timestamp = options[:'auto-gen-timestamp']
-      @pull_request = PullRequest.new(extract_pull_request_options(options))
     end
 
     # Executes Rubocop Challenge flow
@@ -45,27 +47,15 @@ module RubocopChallenger
 
     private
 
-    attr_reader :options, :pull_request, :exclude_limit, :auto_gen_timestamp
+    attr_reader :options
 
-    # Extracts options for the PullRequest class
-    #
-    # @param options [Hash] The target options
-    # @return [Hash] Options for the PullRequest class
-    def extract_pull_request_options(options)
-      {
-        user_name: options[:name],
-        user_email: options[:email],
-        base_branch: options[:base_branch],
-        labels: options[:labels],
-        dry_run: options[:'no-create-pr'],
-        project_column_name: options[:project_column_name],
-        project_id: options[:project_id]
-      }
+    def pull_request
+      @pull_request ||= PullRequest.new(**pull_request_options)
     end
 
     # Executes `$ bundle update` for the rubocop and the associated gems
     def update_rubocop!
-      bundler = Bundler::Command.new
+      bundler = Bundler::Command.new(verbose: options[:verbose])
       pull_request.commit! ':police_car: $ bundle update rubocop' do
         bundler.update(*RSPEC_GEMS)
       end
@@ -79,10 +69,7 @@ module RubocopChallenger
     def regenerate_rubocop_todo!
       before_version = scan_rubocop_version_in_rubocop_todo_file
       pull_request.commit! ':police_car: regenerate rubocop todo' do
-        Rubocop::Command.new.auto_gen_config(
-          exclude_limit: exclude_limit,
-          auto_gen_timestamp: auto_gen_timestamp
-        )
+        Rubocop::Command.new.auto_gen_config(**auto_gen_config_options)
       end
       after_version = scan_rubocop_version_in_rubocop_todo_file
 
@@ -107,7 +94,7 @@ module RubocopChallenger
     # @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|
+      Rubocop::Challenge.exec(**rubocop_challenge_options).tap do |rule|
         pull_request.commit! ":police_car: #{rule.title}"
       end
     rescue Errors::NoAutoCorrectableRule => e
@@ -171,5 +158,33 @@ module RubocopChallenger
       todo_reader = Rubocop::TodoReader.new(options[:file_path])
       todo_reader.all_rules.include?(rule)
     end
+
+    def rubocop_challenge_options
+      {
+        file_path: options[:file_path],
+        mode: options[:mode],
+        only_safe_auto_correct: options[:'only-safe-auto-correct']
+      }
+    end
+
+    def pull_request_options
+      {
+        user_name: options[:name],
+        user_email: options[:email],
+        base_branch: options[:base_branch],
+        labels: options[:labels],
+        dry_run: options[:'no-create-pr'],
+        project_column_name: options[:project_column_name],
+        project_id: options[:project_id],
+        verbose: options[:verbose]
+      }
+    end
+
+    def auto_gen_config_options
+      {
+        exclude_limit: options[:'exclude-limit'],
+        auto_gen_timestamp: options[:'auto-gen-timestamp']
+      }
+    end
   end
 end