rubocop_challenger 0.5.2 → 1.0.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37ec8fd817642a69fe7bb68c99b6517f0058d7e8bc869b92f102e8b9e0ea1212
-  data.tar.gz: 04caf2ba5be3f8b41b27dc7fcaf7fb69eea7cbc466e9be1521c614dfe79dffb5
+  metadata.gz: be161f42b0b71a8b844def77b8bf6804e509b2031e8c36414cca774e7a2c9d52
+  data.tar.gz: d25cc54a5fe1b7c790a777be33f588ee077c5e2e7bdda3859036b0cfdb6f8f09
 SHA512:
-  metadata.gz: 750395303ee97a2cd991531a64ed837635537e85a3cbefa6e43efda0a0e970bdc37e74b11f632a74079f4afa1b3f245cbfc71910b0e09992365ba9117918f6eb
-  data.tar.gz: f6a587358270e6f32233014a931b62d4df600a22e9931af220553f6765c674859ddf80c485a3f6819ac95da18421de8ad5e8fb10e5d7c10b78d3d8e285db517a
+  metadata.gz: cc662bd2602a49e01778f9d7cce01a1c9b1355ce34d0a787bb2069bbb047b91dfd781831991eb7948aa767a74466ccb33cab46954ae67eb723e6347d24347b43
+  data.tar.gz: 6ba85d28bd29051e39398edb5ef81737bf3181fc99d05140b541d13d92e299a4964822f25c9e72536958d357c6c8170f3e080760c4800c40786782a4fb630163

data/.rubocop.yml

@@ -8,3 +8,8 @@ AllCops:
 Metrics/BlockLength:
   Exclude:
     - 'spec/**/*'
+
+# For integration testing
+RSpec/MultipleExpectations:
+  Exclude:
+    - 'spec/rubocop_challenger/cli_spec.rb'

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2018-11-04 14:59:09 +0900 using RuboCop version 0.60.0.
+# on 2018-11-13 10:11:54 +0900 using RuboCop version 0.60.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,8 @@
 PATH
   remote: .
   specs:
-    rubocop_challenger (0.5.2)
-      pr-daikou (~> 0.2.0)
+    rubocop_challenger (1.0.0.pre)
+      octokit
       rubocop
       rubocop-rspec
       thor
@@ -11,16 +11,23 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
     ast (2.4.0)
     diff-lcs (1.3)
     docile (1.3.1)
+    faraday (0.15.3)
+      multipart-post (>= 1.2, < 3)
     jaro_winkler (1.5.1)
     json (2.1.0)
+    multipart-post (2.0.0)
+    octokit (4.13.0)
+      sawyer (~> 0.8.0, >= 0.5.3)
     parallel (1.12.1)
     parser (2.5.3.0)
       ast (~> 2.4.0)
     powerpack (0.1.2)
-    pr-daikou (0.2.0)
+    public_suffix (3.0.3)
     rainbow (3.0.0)
     rake (10.5.0)
     rspec (3.8.0)
@@ -49,12 +56,15 @@ GEM
     rubocop-rspec (1.30.1)
       rubocop (>= 0.60.0)
     ruby-progressbar (1.10.0)
+    sawyer (0.8.1)
+      addressable (>= 2.3.5, < 2.6)
+      faraday (~> 0.8, < 1.0)
     simplecov (0.16.1)
       docile (~> 1.1)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
-    thor (0.20.0)
+    thor (0.20.3)
     unicode-display_width (1.4.0)
     yard (0.9.16)
 

data/README.md

@@ -55,8 +55,8 @@ jobs:
           command: |
             bundle install
             bundle exec rubocop_challenger go \
-              --email=rubocop-challenge@example.com \
-              --name="'Rubocop Challenge'"
+              --email=rubocop-challenger@example.com \
+              --name="'Rubocop Challenger'"
 
 workflows:
   version: 2
@@ -79,7 +79,7 @@ workflows:
 $ rubocop_challenger help
 
 Commands:
-  rubocop_challenger go --email=EMAIL --name=NAME  # Run `$ rubocop --auto-correct` and create PR to your GitHub repository
+  rubocop_challenger go --email=EMAIL --name=NAME  # Run `$ rubocop --auto-correct` and create PR to GitHub repo
   rubocop_challenger help [COMMAND]                # Describe available commands or one specific command
   rubocop_challenger version                       # Show current version
 ```
@@ -105,9 +105,10 @@ Options:
   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
+                                                                   # Default: true
       [--no-commit]                                                # No commit after autocorrect
 
-Run `$ rubocop --auto-correct` and create PR to your GitHub repository
+Run `$ rubocop --auto-correct` and create PR to GitHub repo
 ```
 
 ## Requirement

data/bin/create_release_pr

@@ -11,42 +11,39 @@ def exit_process(error_message)
   exit!
 end
 
-def exist_uncommitted_modify?
-  `git add -n .; git diff --name-only` != ''
-end
-
-VERSION_FORMAT = /\A\d+\.\d+\.\d+\z/.freeze
+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(
+    access_token: ENV['GITHUB_ACCESS_TOKEN'],
+    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
-exit_process 'There are uncommitted modify' if exist_uncommitted_modify?
 
 # Modify a version file
-File.write('lib/rubocop_challenger/version.rb', <<~VERSION)
-  # frozen_string_literal: true
-
-  module RubocopChallenger
-    VERSION = '#{version}'
-  end
-VERSION
+pr_creater.commit 'Update version' do
+  File.write('lib/rubocop_challenger/version.rb', <<~VERSION)
+    # frozen_string_literal: true
+
+    module RubocopChallenger
+      VERSION = '#{version}'
+    end
+  VERSION
+end
 
 # Bundle Update
-`bundle update`
+pr_creater.commit 'Run $ bundle update' do
+  `bundle update`
+end
 
 # Regenerate .rubocop_todo.yml
-`bundle exec rubocop --auto-gen-config`
+pr_creater.commit 'Regenerate .rubocop_todo.yml' do
+  rubocop.auto_gen_config
+end
 
 # Create PR
-PRDaikou.exec(
-  {
-    email: `git config user.email`,
-    name: `git config user.name`,
-    base: 'master',
-    title: "Update v#{version}",
-    labels: '',
-    topic: "update/v#{version}",
-    commit: "Update v#{version}"
-  }, nil
-)
+pr_creater.create_pr(title: "Update v#{version}", body: '', base: 'master')

data/challenger.gemspec

@@ -22,7 +22,7 @@ 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-daikou', '~> 0.2.0'
+  spec.add_runtime_dependency 'octokit'
   spec.add_runtime_dependency 'rubocop'
   spec.add_runtime_dependency 'rubocop-rspec'
   spec.add_runtime_dependency 'thor'

data/lib/rubocop_challenger.rb

@@ -2,8 +2,12 @@
 
 require 'erb'
 require 'yard'
+require 'octokit'
 require 'rubocop'
 require 'rubocop-rspec'
+require 'rubocop_challenger/errors'
+require 'rubocop_challenger/version'
+require 'rubocop_challenger/command_line'
 require 'rubocop_challenger/rubocop/rule'
 require 'rubocop_challenger/rubocop/todo_reader'
 require 'rubocop_challenger/rubocop/todo_writer'
@@ -11,6 +15,7 @@ require 'rubocop_challenger/rubocop/command'
 require 'rubocop_challenger/rubocop/challenge'
 require 'rubocop_challenger/rubocop/yardoc'
 require 'rubocop_challenger/cli'
-require 'rubocop_challenger/version'
-require 'rubocop_challenger/github/pr_template.rb'
-require 'pr-daikou'
+require 'rubocop_challenger/git/command'
+require 'rubocop_challenger/github/client'
+require 'rubocop_challenger/github/pr_template'
+require 'rubocop_challenger/github/pr_creater'

data/lib/rubocop_challenger/cli.rb

@@ -42,7 +42,7 @@ module RubocopChallenger
            desc: 'Label to give to Pull Request'
     option :'regenerate-rubocop-todo',
            type: :boolean,
-           default: false,
+           default: true,
            desc: 'Rerun `$ rubocop --auto-gen-config` after autocorrect'
     option :'no-commit',
            type: :boolean,
@@ -72,48 +72,53 @@ module RubocopChallenger
 
     private
 
+    def pr_creater
+      @pr_creater ||= Github::PrCreater.new(
+        access_token: ENV['GITHUB_ACCESS_TOKEN'],
+        branch: "rubocop-challenge/#{timestamp}",
+        user_name: options[:name],
+        user_email: options[:email]
+      )
+    end
+
     def rubocop_challenge
-      Rubocop::Challenge.exec(options[:file_path], options[:mode])
+      target_rule = Rubocop::Challenge.exec(options[:file_path], options[:mode])
+      pr_creater.commit ":robot: #{target_rule.title}"
+      target_rule
     end
 
     def regenerate_rubocop_todo
       return unless options[:'regenerate-rubocop-todo']
 
-      Rubocop::Command.new.auto_gen_config
+      pr_creater.commit ':robot: regenerate rubocop todo' do
+        Rubocop::Command.new.auto_gen_config
+      end
     end
 
     def create_pull_request(rule)
-      pr_daikou_options = generate_pr_daikou_options(rule)
+      pr_creater_options = generate_pr_creater_options(rule)
       return if options[:'no-commit']
 
-      PRDaikou.exec(pr_daikou_options, nil)
+      pr_creater.create_pr(pr_creater_options)
     end
 
-    def generate_pr_daikou_options(target_rule)
+    def generate_pr_creater_options(rule)
       {
-        email: options[:email],
-        name: options[:name],
+        title: "#{rule.title}-#{timestamp}",
+        body: generate_pr_body(rule),
         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}"
+        labels: options[:labels]
       }
     end
 
-    def generate_topic(rule)
-      "rubocop-challenge/#{rule.title.tr('/', '-')}-#{timestamp}"
-    end
-
-    def pr_template(rule)
+    def generate_pr_body(rule)
       Github::PrTemplate
         .new(rule, options[:template])
         .generate_pullrequest_markdown
     end
 
     def timestamp
-      Time.now.strftime('%Y%m%d%H%M%S')
+      @timestamp ||= Time.now.strftime('%Y%m%d%H%M%S')
     end
   end
 end

data/lib/rubocop_challenger/command_line.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module RubocopChallenger
+  # To execute command line. You should inherit this class to use.
+  class CommandLine
+    private
+
+    # Execute a command
+    #
+    # @param command [String] The command you want to execute
+    # @return [String] Execution result
+    def execute(command)
+      puts "$ #{command}"
+      `#{command}`.chomp
+    end
+  end
+end

data/lib/rubocop_challenger/errors.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RubocopChallenger
+  module Errors
+    class ExistUncommittedModify < StandardError; end
+  end
+end

data/lib/rubocop_challenger/git/command.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module RubocopChallenger
+  module Git
+    # To execute git command
+    class Command < CommandLine
+      def initialize(user_name: nil, user_email: nil)
+        @user_name = user_name
+        @user_email = user_email
+      end
+
+      def user_name
+        @user_name ||= config('user.name')
+      end
+
+      def user_email
+        @user_email ||= config('user.email')
+      end
+
+      def exist_uncommitted_modify?
+        execute('git add -n .; git diff --name-only') != ''
+      end
+
+      def checkout(branch)
+        run('checkout', branch)
+      end
+
+      def checkout_with(new_branch)
+        run('checkout', '-b', new_branch)
+      end
+
+      def add(*files)
+        run('add', *files)
+      end
+
+      def commit(message)
+        run_with_environments('commit', '-m', "\"#{message}\"")
+      end
+
+      def push(remote, branch = current_branch)
+        run('push', remote, branch)
+      end
+
+      def current_sha1
+        run('rev-parse', 'HEAD')
+      end
+
+      def current_sha1?(sha1)
+        current_sha1 == sha1.to_s
+      end
+
+      def current_branch
+        run('rev-parse', '--abbrev-ref', 'HEAD')
+      end
+
+      def current_branch?(branch)
+        current_branch == branch.to_s
+      end
+
+      def remote_url(remote)
+        run('remote', 'get-url', '--push', remote)
+      end
+
+      private
+
+      def run(*subcommands)
+        command = "git #{subcommands.join(' ')}"
+        execute(command)
+      end
+
+      def run_with_environments(*subcommands)
+        command = "#{environments} git #{subcommands.join(' ')}"
+        execute(command)
+      end
+
+      def config(key)
+        run('config', key)
+      end
+
+      def environments
+        @environments ||= [
+          "GIT_AUTHOR_NAME=\"#{user_name}\"",
+          "GIT_AUTHOR_EMAIL=\"#{user_email}\"",
+          "GIT_COMMITTER_NAME=\"#{user_name}\"",
+          "GIT_COMMITTER_EMAIL=\"#{user_email}\""
+        ].join(' ')
+      end
+    end
+  end
+end

data/lib/rubocop_challenger/github/client.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module RubocopChallenger
+  module Github
+    # GitHub API Client
+    class Client
+      attr_reader :repository
+
+      def initialize(access_token, remote_url)
+        @client = Octokit::Client.new(access_token: access_token)
+        @repository = remote_url.match(REPOSITORY_MATCHER)[:repository]
+      end
+
+      # Create a pull request
+      #
+      # @param base [String] The branch you want your changes pulled into
+      # @param head [String] The branch where your changes are implemented
+      # @param title [String] Title for the pull request
+      # @param body [String] The body for the pull request
+      # @return [Integer] Created pull request number
+      def create_pull_request(base:, head:, title:, body:)
+        response =
+          client.create_pull_request(repository, base, head, title, body)
+        response.number
+      end
+
+      # Description of #add_labels
+      #
+      # @param issue_number [Integer] Number ID of the issue (or pull request)
+      # @param labels [Array<String>] An array of labels to apply to this Issue
+      def add_labels(issue_number, *labels)
+        client.add_labels_to_an_issue(repository, issue_number, labels)
+      end
+
+      private
+
+      REPOSITORY_MATCHER = %r{github\.com[:/](?<repository>.+)\.git}.freeze
+
+      attr_reader :client
+    end
+  end
+end

data/lib/rubocop_challenger/github/pr_creater.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module RubocopChallenger
+  module Github
+    # To create Pull Request
+    class PrCreater
+      # Returns a new instance of Github::PrCreater
+      #
+      # @param access_token [String] The GitHub access token
+      # @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(access_token:, branch:, user_name: nil, user_email: nil)
+        @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'))
+        @initial_sha1 = git.current_sha1
+      end
+
+      # Add and commit local files to this branch
+      #
+      # @param message [String] The commit message
+      # @yield Some commands where modify local files
+      # @return [Object] Return result of yield if you use &block
+      # @raise [RubocopChallenger::Errors::ExistUncommittedModify]
+      #        Raise error if you use &block and exists someuncommitted files
+      def commit(message, &block)
+        git.checkout_with(topic_branch) unless git.current_branch?(topic_branch)
+        result = modify_files(&block) if block_given?
+        git.add('.')
+        git.commit(message)
+        result
+      end
+
+      # Create a pull request
+      # You should call #commit before calling this method
+      #
+      # @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)
+        return false unless git_condition_valid?
+
+        git.push('origin', topic_branch)
+        pr_number = github.create_pull_request(
+          base: base, head: topic_branch, title: title, body: body
+        )
+        github.add_labels(pr_number, labels) unless labels.nil?
+        true
+      end
+
+      private
+
+      attr_reader :git, :github, :topic_branch, :initial_sha1
+
+      def git_condition_valid?
+        !git.current_sha1?(initial_sha1) && git.current_branch?(topic_branch)
+      end
+
+      def modify_files
+        raise Errors::ExistUncommittedModify if git.exist_uncommitted_modify?
+
+        yield
+      end
+    end
+  end
+end

data/lib/rubocop_challenger/rubocop/command.rb

@@ -3,13 +3,20 @@
 module RubocopChallenger
   module Rubocop
     # To execute rubocop gem command (Mainly for mock when testing)
-    class Command
+    class Command < CommandLine
       def auto_correct
-        `bundle exec rubocop --auto-correct || true`
+        run('--auto-correct')
       end
 
       def auto_gen_config
-        `bundle exec rubocop --auto-gen-config || true`
+        run('--auto-gen-config')
+      end
+
+      private
+
+      def run(*subcommands)
+        command = "bundle exec rubocop #{subcommands.join(' ')} || true"
+        execute(command)
       end
     end
   end

data/lib/rubocop_challenger/version.rb

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

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: rubocop_challenger
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 1.0.0.pre
 platform: ruby
 authors:
 - ryosuke_sato
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-04 00:00:00.000000000 Z
+date: 2018-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: pr-daikou
+  name: octokit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -181,6 +181,11 @@ files:
 - images/rubocop_challenge.png
 - lib/rubocop_challenger.rb
 - lib/rubocop_challenger/cli.rb
+- lib/rubocop_challenger/command_line.rb
+- lib/rubocop_challenger/errors.rb
+- lib/rubocop_challenger/git/command.rb
+- lib/rubocop_challenger/github/client.rb
+- lib/rubocop_challenger/github/pr_creater.rb
 - lib/rubocop_challenger/github/pr_template.rb
 - lib/rubocop_challenger/rubocop/challenge.rb
 - lib/rubocop_challenger/rubocop/command.rb
@@ -206,9 +211,9 @@ 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: []
 rubyforge_project: 
 rubygems_version: 2.7.8