rubocop_challenger 2.0.0.pre4 → 2.0.0.pre5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 036a98418d15e70500e3d367abda85fd4ebdfcc1a62026d71388043f691afcc4
-  data.tar.gz: 10699bfb6619de26f91d767a58f5998e9d0ed3d9fc00be3be849adb20d37b512
+  metadata.gz: b7d1fa4268fdf70c18f0d5e2f0529e40f44932af9722c8b5d3d602711255fcb6
+  data.tar.gz: 3b1fce68b3d66ccfc0c504eccc608f5f02b41d731f027abe97fb78e07c8563ab
 SHA512:
-  metadata.gz: a8b3eba01b0794ede0a9c286f022bf9c5060f26d94da1033406165c88b4445c99cfd8231447f5888110671314c3a35bf2d6c454c21920b0287c9fc17e9ac03c6
-  data.tar.gz: 657dba914ff64870f44291cacdebd178ddd80ac9e76c6932a2c3dbb2dedbba39597e7e202858ae0737ca8e4843ce26fb8495ae3afe51dd9264a1fd7399678b6a
+  metadata.gz: 229ca155ff15eabf0c94e00645a06ef3d443573952982e623fcb9dec475ace6353dddc0f328c2717d7f856762d942e4bb9225d4e9721647527c2c6365a68e834
+  data.tar.gz: abfb7b4136efe1f930fd3c87aaa9f08ad7f3cdeb7375def8d38e8c4571de9cf22584f486bcbe5f355a35adec37611499c3d58d28e5c04d736fa5bb7e0937a9c8

data/.rubocop.yml

@@ -7,6 +7,7 @@ AllCops:
 
 Metrics/BlockLength:
   Exclude:
+    - 'challenger.gemspec'
     - 'spec/**/*'
 
 # For integration testing

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2019-06-10 12:04:42 +0900 using RuboCop version 0.71.0.
+# on 2019-06-13 12:10:32 +0900 using RuboCop version 0.71.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,8 +1,9 @@
 PATH
   remote: .
   specs:
-    rubocop_challenger (2.0.0.pre4)
-      pr_comet (~> 0.1.0)
+    rubocop_challenger (2.0.0.pre5)
+      pr_comet (~> 0.2.0)
+      rainbow
       rubocop
       rubocop-rspec
       thor
@@ -17,7 +18,7 @@ GEM
     byebug (11.0.1)
     coderay (1.1.2)
     diff-lcs (1.3)
-    docile (1.3.1)
+    docile (1.3.2)
     faraday (0.15.4)
       multipart-post (>= 1.2, < 3)
     jaro_winkler (1.5.2)
@@ -29,8 +30,9 @@ GEM
     parallel (1.17.0)
     parser (2.6.3.0)
       ast (~> 2.4.0)
-    pr_comet (0.1.1)
+    pr_comet (0.2.0)
       octokit
+      rainbow
     pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
@@ -46,13 +48,13 @@ GEM
       rspec-mocks (~> 3.8.0)
     rspec-core (3.8.0)
       rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.3)
+    rspec-expectations (3.8.4)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-mocks (3.8.0)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
+    rspec-support (3.8.2)
     rspec_junit_formatter (0.4.1)
       rspec-core (>= 2, < 4, != 2.12.0)
     rubocop (0.71.0)

data/README.md

@@ -109,16 +109,19 @@ 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
-  l, [--labels=one two three]  # Label to give to Pull Request
-                               # Default: ["rubocop challenge"]
-      [--no-create-pr]         # No create a pull request (for testing)
+      --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)
+      [--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
 
 Run `$ rubocop --auto-correct` and create a PR to GitHub repo
 ```

data/challenger.gemspec

@@ -22,7 +22,8 @@ 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.1.0'
+  spec.add_runtime_dependency 'pr_comet', '~> 0.2.0'
+  spec.add_runtime_dependency 'rainbow'
   spec.add_runtime_dependency 'rubocop'
   spec.add_runtime_dependency 'rubocop-rspec'
   spec.add_runtime_dependency 'thor'

data/lib/rubocop_challenger.rb

@@ -2,6 +2,7 @@
 
 require 'erb'
 require 'yard'
+require 'rainbow'
 require 'pr_comet'
 require 'rubocop'
 require 'rubocop-rspec'

data/lib/rubocop_challenger/bundler/command.rb

@@ -6,10 +6,16 @@ module RubocopChallenger
     class Command
       include PrComet::CommandLine
 
+      # 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)
+        run('update', *gem_names.select(&method(:installed?)))
       end
 
+      # Checks the gem is installed
+      #
+      # @return [Boolean] Returns true if installed
       def installed?(gem_name)
         !run('list', '|', 'grep', gem_name).empty?
       end

data/lib/rubocop_challenger/cli.rb

@@ -5,8 +5,6 @@ require 'thor'
 module RubocopChallenger
   # To define CLI commands
   class CLI < Thor
-    include PrComet::CommandLine
-
     desc 'go', 'Run `$ rubocop --auto-correct` and create a PR to GitHub repo'
     option :email,
            required: true,
@@ -37,16 +35,33 @@ module RubocopChallenger
            default: ['rubocop challenge'],
            aliases: :l,
            desc: 'Label to give to Pull Request'
+    option :project_column_name,
+           type: :string,
+           desc: 'A project column name. You can add the created PR to the ' \
+                 'GitHub project'
+    option :project_id,
+           type: :numeric,
+           desc: '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 :'no-create-pr',
            type: :boolean,
            default: false,
            desc: 'No create a pull request (for testing)'
+    option :'exclude-limit',
+           type: :numeric,
+           desc: 'For how many exclude properties when creating the ' \
+                 '.rubocop_todo.yml'
+    option :'auto-gen-timestamp',
+           type: :boolean,
+           default: true,
+           desc: 'Include the date and time when creating the .rubocop_todo.yml'
     def go
       Go.new(options).exec
     rescue Errors::NoAutoCorrectableRule => e
-      color_puts e.message, PrComet::CommandLine::YELLOW
+      puts Rainbow(e.message).yellow
     rescue StandardError => e
-      color_puts e.message, PrComet::CommandLine::RED
+      puts Rainbow(e.message).red
       exit_process!
     end
 

data/lib/rubocop_challenger/go.rb

@@ -3,17 +3,31 @@
 module RubocopChallenger
   # Executes Rubocop Challenge flow
   class Go
-    include PrComet::CommandLine
-
-    # @param options [Hash] describe_options_here
+    # @param options [Hash]
+    #   Options for the rubocop challenge
+    # @option exclude-limit [Integer]
+    #   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 name [String]
+    #   The author name which use at the git commit
+    # @option email [String]
+    #   The email address which use at the git commit
+    # @option labels [Array<String>]
+    #   Will create a pull request with the labels
+    # @option no-create-pr [Boolean]
+    #   Does not create a pull request when given `true`
+    # @option project_column_name [String]
+    #   A project column name. You can add the created PR to the GitHub project
+    # @option project_id [Integer]
+    #   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.
     def initialize(options)
       @options = options
-      @pull_request = PullRequest.new(
-        options[:name],
-        options[:email],
-        options[:labels],
-        options[:'no-create-pr']
-      )
+      @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
@@ -31,13 +45,31 @@ module RubocopChallenger
 
     private
 
-    attr_reader :options, :pull_request
+    attr_reader :options, :pull_request, :exclude_limit, :auto_gen_timestamp
+
+    # 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],
+        labels: options[:labels],
+        dry_run: options[:'no-create-pr'],
+        project_column_name: options[:project_column_name],
+        project_id: options[:project_id]
+      }
+    end
 
+    # Executes `$ bundle update` for the rubocop and the associated gems
     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')
+        bundler.update 'rubocop',
+                       'rubocop-performance',
+                       'rubocop-rails',
+                       'rubocop-rspec'
       end
     end
 
@@ -49,7 +81,10 @@ 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
+        Rubocop::Command.new.auto_gen_config(
+          exclude_limit: exclude_limit,
+          auto_gen_timestamp: auto_gen_timestamp
+        )
       end
       after_version = scan_rubocop_version_in_rubocop_todo_file
 
@@ -126,8 +161,7 @@ module RubocopChallenger
         config_editor.add_ignore(rule)
         config_editor.save
       end
-      color_puts DESCRIPTION_THAT_CHALLENGE_IS_INCOMPLETE,
-                 PrComet::CommandLine::YELLOW
+      puts Rainbow(DESCRIPTION_THAT_CHALLENGE_IS_INCOMPLETE).yellow
     end
 
     # Checks the challenge result. If the challenge is successed, the rule

data/lib/rubocop_challenger/pull_request.rb

@@ -7,19 +7,29 @@ module RubocopChallenger
     #   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>]
+    # @param options [Hash]
+    #   Optional parameters
+    # @option labels [Array<String>]
     #   Will create a pull request with the labels
-    # @param dry_run [Boolean]
+    # @option dry_run [Boolean]
     #   Does not create a pull request when given `true`
-    def initialize(user_name, user_email, labels, dry_run = false)
+    # @option project_column_name [String]
+    #   A project column name. You can add the created PR to the GitHub project
+    # @option project_id [Integer]
+    #   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.
+    def initialize(user_name:, user_email:, **options)
       @pr_comet = PrComet.new(
         base: 'master',
         branch: "rubocop-challenge/#{timestamp}",
         user_name: user_name,
         user_email: user_email
       )
-      @labels = labels
-      @dry_run = dry_run
+      @labels = options[:labels]
+      @dry_run = options[:dry_run]
+      @project_column_name = options[:project_column_name]
+      @project_id = options[:project_id]
     end
 
     # Add and commit local files to the pull request
@@ -42,8 +52,7 @@ module RubocopChallenger
     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
+        body: Github::PrTemplate.new(rule, template_file_path).generate
       )
     end
 
@@ -61,18 +70,25 @@ module RubocopChallenger
     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
+        body: generate_pull_request_body(before_version, after_version)
       )
     end
 
     private
 
-    attr_reader :pr_comet, :labels, :dry_run
+    attr_reader :pr_comet, :labels, :dry_run, :project_column_name, :project_id
 
     # Create a PR with description of what modification were made.
+    #
+    # @params pr_comet_options [Hash]
     def create_pull_request!(pr_comet_options)
-      pr_comet.create!(pr_comet_options) unless dry_run
+      options = {
+        labels: labels,
+        project_column_name: project_column_name,
+        project_id: project_id
+      }.merge(pr_comet_options)
+
+      pr_comet.create!(options) unless dry_run
     end
 
     # @param before_version [String]

data/lib/rubocop_challenger/rubocop/command.rb

@@ -6,12 +6,20 @@ module RubocopChallenger
     class Command
       include PrComet::CommandLine
 
+      # Executes auto correction
       def auto_correct
         run('--auto-correct')
       end
 
-      def auto_gen_config
-        run('--auto-gen-config')
+      # Generates `.rubocop_todo.yml`
+      #
+      # @param exclude_limit [Integer] default: nil
+      # @param auto_gen_timestamp [Boolean] default: true
+      def auto_gen_config(exclude_limit: nil, auto_gen_timestamp: true)
+        commands = ['--auto-gen-config']
+        commands << "--exclude-limit #{exclude_limit}" if exclude_limit
+        commands << '--no-auto-gen-timestamp' unless auto_gen_timestamp
+        run(*commands)
       end
 
       private

data/lib/rubocop_challenger/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop_challenger
 version: !ruby/object:Gem::Version
-  version: 2.0.0.pre4
+  version: 2.0.0.pre5
 platform: ruby
 authors:
 - ryosuke_sato
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-10 00:00:00.000000000 Z
+date: 2019-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pr_comet
@@ -16,14 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement