rubocop_challenger 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c793807b7c62bf1aa08436ec4d4de3630a00825e239d8c5d6122f94651b7dd1
-  data.tar.gz: 50d56cc0b7da03c6f66d6aa93b6e5e814f0b6061997f727b8393bbc85487cc02
+  metadata.gz: 8ba8deecbf49b350474a9144e4a1bf8f31d50d287e5dd51f0c3685ad01f86c17
+  data.tar.gz: 4c8eef6d0c2d989a8b566b9989364a594f9d874f4c2750096b73dafa8954f6dd
 SHA512:
-  metadata.gz: 39ac6e8bb72d0b7a0e941a33dd09a0dd1701c9d59fb3557a7096e0f383c76ee042a29da225bbc80fbc505d2cbfd1e3eced511ef68b90c3a555153ab2f3a85ff1
-  data.tar.gz: 49f651edd5fd9601ecac5f3fca3914c2f373efd8fab4dcd9df5fdb40328f811b3851644efdc1487a30134427dc2fc029f1904e52a892057007f5c18baece123a
+  metadata.gz: eb9a03b11502c7d5169d8082af81af23d603480ca2de1d2bf216fb40fdcc7caf3142466121a93065f4e3754f43ec6c2a3a2fa8c8b166ad2745a9c2c656f38acc
+  data.tar.gz: ec425dcd9f57d26241be0e304f983c656db68cef4e6a9386bc7ef1685ff6700efa1927a14290d6b1558106244e426f4ced6561039f7f669d2be2e4937782b515

data/.circleci/config.yml

@@ -78,8 +78,7 @@ jobs:
     docker:
        - image: circleci/ruby:2.3-node-browsers
     <<: *rubocop
-
-  rubocop_challenge:
+  verify_rubocop_challenge:
     docker:
       - image: circleci/ruby:2.3-node-browsers
     working_directory: ~/repo
@@ -90,14 +89,16 @@ jobs:
       - *save_bundle_install_cache
       - run: bundle exec rake install
       - run:
-          name: Rubocop Challenge
+          name: Verify Rubocop Challenge
           command: |
             bundle exec exe/rubocop_challenger go \
               --email=ryz310@gmail.com \
               --name=ryz310 \
-              --mode=random
+              --mode=random \
+              --regenerate-rubocop-todo \
+              --no-commit
 
-  rubocop_challenge_from_gem:
+  rubocop_challenge:
     docker:
       - image: circleci/ruby:2.3-node-browsers
     working_directory: ~/repo
@@ -106,10 +107,11 @@ jobs:
       - run:
           name: Rubocop Challenge
           command: |
-            gem install rubocop_challenger
+            gem install -N rubocop_challenger
             rubocop_challenger go \
               --email=ryz310@gmail.com \
-              --name=ryz310
+              --name=ryz310 \
+              --regenerate-rubocop-todo
 
   release:
     docker:
@@ -142,17 +144,7 @@ workflows:
       - build_on_ruby_2.5
       - build_on_ruby_latest
       - rubocop
-      - rubocop_challenge:
-          requires:
-            - build_on_ruby_2.3
-            - build_on_ruby_2.4
-            - build_on_ruby_2.5
-            - build_on_ruby_latest
-            - rubocop
-          filters:
-            branches:
-              only:
-                - master
+      - verify_rubocop_challenge
       - release:
           context: RubyGems API Key
           requires:
@@ -169,10 +161,10 @@ workflows:
   challenge:
     triggers:
       - schedule:
-          cron: "30 23 * * 5" # 8:30am every Saturday (JST)
+          cron: "30 23 * * *" # 8:30am every day (JST)
           filters:
             branches:
               only:
                 - master
     jobs:
-      - rubocop_challenge_from_gem
+      - rubocop_challenge

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2018-10-21 01:10:29 +0900 using RuboCop version 0.59.2.
+# on 2018-10-22 15:21:40 +0900 using RuboCop version 0.59.2.
 # 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
@@ -27,13 +27,14 @@ RSpec/ExampleLength:
   Exclude:
     - 'spec/rubocop_challenger/rubocop/todo_reader_spec.rb'
 
-# Offense count: 7
+# Offense count: 8
 Style/Documentation:
   Exclude:
     - 'spec/**/*'
     - 'test/**/*'
     - 'lib/rubocop_challenger.rb'
     - 'lib/rubocop_challenger/cli.rb'
+    - 'lib/rubocop_challenger/github/pr_template.rb'
     - 'lib/rubocop_challenger/rubocop/challenge.rb'
     - 'lib/rubocop_challenger/rubocop/command.rb'
     - 'lib/rubocop_challenger/rubocop/rule.rb'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rubocop_challenger (0.1.3)
+    rubocop_challenger (0.2.0)
       pr-daikou (~> 0.2.0)
       rubocop
       rubocop-rspec

data/README.md

@@ -10,12 +10,24 @@ I call such work *Rubocop Challenge*. And the *RubocopChallenger* is a gem to su
 ## Rubocop Challenge Flow
 
 1. Run *RubocopChallenger* periodically from CI tool etc.
-2. 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
-3. You confirm the PR passes testing and then merge it if there is no problem
+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. You confirm the PR passes testing and then merge it if there is no problem
 
-## Example
+## Usage
+
+### 1. Setting GitHub personal access token
+
+GitHub personal access token is required for sending pull requests to your repository.
 
-### Using [CircleCI 2.0](https://circleci.com)
+1. Go to [your account's settings page](https://github.com/settings/tokens) and [generate a new token](https://github.com/settings/tokens/new) with "repo" scope
+  ![generate token](images/generate_token.png)
+1. On [CircleCI](https://circleci.com) dashboard, go to your application's "Project Settings" -> "Environment Variables"
+1. Add an environment variable `GITHUB_ACCESS_TOKEN` with your GitHub personal access token
+  ![circleci environment variables](images/circleci_environment_variables.png)
+
+### 2. Configure .circleci/config.yml
+
+Configure your `.circleci/config.yml` to run rubocop_challenger, for example:
 
 ```yml
 # .circleci/config.yml
@@ -31,7 +43,7 @@ jobs:
       - run:
           name: Rubocop Challenge
           command: |
-            gem install rubocop_challenger
+            gem install -N rubocop_challenger
             rubocop_challenger go \
               --email=rubocop-challenge@example.com \
               --name="'Rubocop Challenge'"
@@ -51,7 +63,7 @@ workflows:
       - rubocop_challenge
 ```
 
-## Usage
+## CLI command references
 
 ```sh
 $ rubocop_challenger help
@@ -71,16 +83,18 @@ 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
-      [--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"]
+      --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
+      [--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"]
+      [--regenerate-rubocop-todo], [--no-regenerate-rubocop-todo]  # Rerun `$ rubocop --auto-gen-config` after autocorrect
+      [--no-commit]                                                # No commit after autocorrect
 
 Run `$ rubocop --auto-correct` and create PR to your GitHub repository
 ```
@@ -88,6 +102,7 @@ Run `$ rubocop --auto-correct` and create PR to your GitHub repository
 ## 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/))
 
 ## Development
 

data/lib/rubocop_challenger.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'erb'
 require 'rubocop'
 require 'rubocop-rspec'
 require 'rubocop_challenger/rubocop/rule'
@@ -9,7 +10,5 @@ require 'rubocop_challenger/rubocop/command'
 require 'rubocop_challenger/rubocop/challenge'
 require 'rubocop_challenger/cli'
 require 'rubocop_challenger/version'
+require 'rubocop_challenger/github/pr_template.rb'
 require 'pr-daikou'
-
-module RubocopChallenger
-end

data/lib/rubocop_challenger/cli.rb

@@ -32,11 +32,21 @@ module RubocopChallenger
            default: ['rubocop challenge'],
            aliases: :l,
            desc: 'Label to give to Pull Request'
+    option :'regenerate-rubocop-todo',
+           type: :boolean,
+           default: false,
+           desc: 'Rerun `$ rubocop --auto-gen-config` after autocorrect'
+    option :'no-commit',
+           type: :boolean,
+           default: false,
+           desc: 'No commit after autocorrect'
     def go
-      target_rule = Rubocop::Challenge.exec(options[:file_path], options[:mode])
-      PRDaikou.exec(pr_daikou_options(target_rule), nil)
+      target_rule = rubocop_challenge
+      regenerate_rubocop_todo
+      create_pull_request(target_rule)
     rescue StandardError => e
       puts e.message
+      exit!
     end
 
     desc 'version', 'Show current version'
@@ -44,24 +54,54 @@ module RubocopChallenger
       puts RubocopChallenger::VERSION
     end
 
+    module ClassMethods
+      # Workaround to return exit code 1 when an error occurs
+      # @see https://github.com/erikhuda/thor/issues/244
+      def exit_on_failure?
+        true
+      end
+    end
+
     private
 
-    def pr_daikou_options(target_rule)
+    def rubocop_challenge
+      Rubocop::Challenge.exec(options[:file_path], options[:mode])
+    end
+
+    def regenerate_rubocop_todo
+      return unless options[:'regenerate-rubocop-todo']
+
+      Rubocop::Command.new.auto_gen_config
+    end
+
+    def create_pull_request(rule)
+      pr_daikou_options = generate_pr_daikou_options(rule)
+      return if options[:'no-commit']
+
+      PRDaikou.exec(pr_daikou_options, nil)
+    end
+
+    def generate_pr_daikou_options(target_rule)
       {
-        email:  options[:email],
-        name:   options[:name],
-        base:   options[:base],
-        title:  target_rule.title,
-        labels: options[:labels].join(','),
-        topic:  topic(target_rule),
-        commit: ":robot: #{target_rule.title}"
+        email:       options[:email],
+        name:        options[:name],
+        base:        options[:base],
+        title:       target_rule.title,
+        description: pr_template(target_rule),
+        labels:      options[:labels].join(','),
+        topic:       generate_topic(target_rule),
+        commit:      ":robot: #{target_rule.title}"
       }
     end
 
-    def topic(rule)
+    def generate_topic(rule)
       "rubocop-challenge/#{rule.title.tr('/', '-')}-#{timestamp}"
     end
 
+    def pr_template(rule)
+      Github::PrTemplate.new(rule).generate_pullrequest_markdown
+    end
+
     def timestamp
       Time.now.strftime('%Y%m%d%H%M%S')
     end

data/lib/rubocop_challenger/github/pr_template.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module RubocopChallenger
+  module Github
+    class PrTemplate
+      def initialize(rule, template_path = nil)
+        template_path ||= './lib/templates/default.md.erb'
+        @template = File.read(template_path)
+        @rule = rule
+      end
+
+      def generate_pullrequest_markdown
+        <<~TEMPLATE
+          #{ERB.new(template, nil, '-').result(binding)}
+          Auto generated by [rubocop_challenger](https://github.com/ryz310/rubocop_challenger)
+        TEMPLATE
+      end
+
+      private
+
+      attr_reader :template, :rule
+
+      def title
+        rule.title
+      end
+
+      def rubydoc_url
+        rule.rubydoc_url
+      end
+
+      def description
+        rule.description
+      end
+    end
+  end
+end

data/lib/rubocop_challenger/rubocop/command.rb

@@ -6,6 +6,10 @@ module RubocopChallenger
       def auto_correct
         `rubocop --auto-correct || true`
       end
+
+      def auto_gen_config
+        `rubocop --auto-gen-config || true`
+      end
     end
   end
 end

data/lib/rubocop_challenger/version.rb

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

data/lib/templates/default.md.erb

@@ -0,0 +1,6 @@
+Rubocop challenge!
+[<%= title %>](<%= rubydoc_url %>)
+
+<% description.each_line do |line| -%>
+> <%= line.chomp %>
+<% end -%>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop_challenger
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - ryosuke_sato
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-20 00:00:00.000000000 Z
+date: 2018-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pr-daikou
@@ -147,14 +147,18 @@ files:
 - bin/setup
 - challenger.gemspec
 - exe/rubocop_challenger
+- images/circleci_environment_variables.png
+- images/generate_token.png
 - lib/rubocop_challenger.rb
 - lib/rubocop_challenger/cli.rb
+- lib/rubocop_challenger/github/pr_template.rb
 - lib/rubocop_challenger/rubocop/challenge.rb
 - lib/rubocop_challenger/rubocop/command.rb
 - lib/rubocop_challenger/rubocop/rule.rb
 - lib/rubocop_challenger/rubocop/todo_reader.rb
 - lib/rubocop_challenger/rubocop/todo_writer.rb
 - lib/rubocop_challenger/version.rb
+- lib/templates/default.md.erb
 homepage: https://github.com/ryz310/rubocop_challenger
 licenses:
 - MIT