pr_comet 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d89965b671d38838d9895fbeb87f2fa300d5837c3d67a58d1fee01beaedfe9c
-  data.tar.gz: 72080a6c89fcdd4e922a3fccd78ee511855e96d096d3bf8887c237a9c723af58
+  metadata.gz: 26c2bf63b04addbcf8944b89f84b026baa7c0345d3888b977448ef5b1376f67c
+  data.tar.gz: ee125a1a0c3f34ba61f97908aeeab173daf06de06ac36a205832dffc37cedecf
 SHA512:
-  metadata.gz: 57f958698936f599fbfdca4025062ff5b76996172714a0d5134d8a36bc7f87904511570e11d8302cdb450a30451b49388c359edc35ba085dd56ba42254164816
-  data.tar.gz: 2cb178a32e7fb35bea01a71054ad7f795fae03a3a48ac860bc2ccc19e9211b11f89f64c84824709fe773713aaed94c52da38a2d3610827517bcf6c0a9cfe1859
+  metadata.gz: 9e26ed62ce34b767a376e7053e3b0abaf02f52fae8994db44f7c5c6d2a13374d98c30801a28c6444597677656ca8c512872688e704610af84b39a0a97ab4b7dc
+  data.tar.gz: cd38ef82bd6adbcaa623bec8f945c54c72012346861f96fc6eda0aaca5bad6a3dc201ba82cf0cf7643eda9c322f28474cd0f7e0f5e5493d5bdf44008dece2ec4

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2019-04-08 22:01:17 +0900 using RuboCop version 0.67.2.
+# on 2019-05-30 23:31:16 +0000 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,13 +1,14 @@
 PATH
   remote: .
   specs:
-    pr_comet (0.1.1)
+    pr_comet (0.2.0)
       octokit
+      rainbow
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.5.2)
+    addressable (2.6.0)
       public_suffix (>= 2.0.2, < 4.0)
     ast (2.4.0)
     byebug (11.0.1)
@@ -19,11 +20,11 @@ GEM
     jaro_winkler (1.5.2)
     json (2.2.0)
     method_source (0.9.2)
-    multipart-post (2.0.0)
+    multipart-post (2.1.1)
     octokit (4.14.0)
       sawyer (~> 0.8.0, >= 0.5.3)
     parallel (1.17.0)
-    parser (2.6.2.1)
+    parser (2.6.3.0)
       ast (~> 2.4.0)
     pry (0.12.2)
       coderay (~> 1.1.0)
@@ -31,8 +32,7 @@ GEM
     pry-byebug (3.7.0)
       byebug (~> 11.0)
       pry (~> 0.10)
-    psych (3.1.0)
-    public_suffix (3.0.3)
+    public_suffix (3.1.0)
     rainbow (3.0.0)
     rake (10.5.0)
     rspec (3.8.0)
@@ -41,7 +41,7 @@ GEM
       rspec-mocks (~> 3.8.0)
     rspec-core (3.8.0)
       rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.2)
+    rspec-expectations (3.8.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-mocks (3.8.0)
@@ -50,28 +50,27 @@ GEM
     rspec-support (3.8.0)
     rspec_junit_formatter (0.4.1)
       rspec-core (>= 2, < 4, != 2.12.0)
-    rubocop (0.67.2)
+    rubocop (0.71.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
-      parser (>= 2.5, != 2.5.1.1)
-      psych (>= 3.1.0)
+      parser (>= 2.6)
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.6)
-    rubocop-performance (1.1.0)
-      rubocop (>= 0.67.0)
-    rubocop-rspec (1.32.0)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    rubocop-performance (1.3.0)
+      rubocop (>= 0.68.0)
+    rubocop-rspec (1.33.0)
       rubocop (>= 0.60.0)
-    ruby-progressbar (1.10.0)
-    sawyer (0.8.1)
-      addressable (>= 2.3.5, < 2.6)
-      faraday (~> 0.8, < 1.0)
+    ruby-progressbar (1.10.1)
+    sawyer (0.8.2)
+      addressable (>= 2.3.5)
+      faraday (> 0.8, < 2.0)
     simplecov (0.16.1)
       docile (~> 1.1)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
-    unicode-display_width (1.5.0)
+    unicode-display_width (1.6.0)
     yard (0.9.19)
 
 PLATFORMS
@@ -91,4 +90,4 @@ DEPENDENCIES
   yard
 
 BUNDLED WITH
-   1.16.6
+   1.17.3

data/README.md

@@ -1,6 +1,6 @@
 # PrComet
 
-[![CircleCI](https://circleci.com/gh/ryz310/pr_comet.svg?style=svg)](https://circleci.com/gh/ryz310/pr_comet) [![Maintainability](https://api.codeclimate.com/v1/badges/962618c106a548ed762b/maintainability)](https://codeclimate.com/github/ryz310/pr_comet/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/962618c106a548ed762b/test_coverage)](https://codeclimate.com/github/ryz310/pr_comet/test_coverage)
+[![CircleCI](https://circleci.com/gh/ryz310/pr_comet.svg?style=svg)](https://circleci.com/gh/ryz310/pr_comet) [![Gem Version](https://badge.fury.io/rb/pr_comet.svg)](https://badge.fury.io/rb/pr_comet) [![Maintainability](https://api.codeclimate.com/v1/badges/962618c106a548ed762b/maintainability)](https://codeclimate.com/github/ryz310/pr_comet/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/962618c106a548ed762b/test_coverage)](https://codeclimate.com/github/ryz310/pr_comet/test_coverage)
 
 Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/pr_comet`. To experiment with that code, run `bin/console` for an interactive prompt.
 

data/lib/pr_comet.rb

@@ -2,6 +2,7 @@
 
 require 'English'
 require 'octokit'
+require 'rainbow'
 require 'pr_comet/version'
 require 'pr_comet/errors'
 require 'pr_comet/command_line'
@@ -46,9 +47,19 @@ class PrComet
   #
   # @param title [String] Title for the pull request
   # @param body [String] The body for the pull request
-  # @param labels [Array<String>] An array of labels to apply to this PR
-  # @return [Boolean] Return true if its successed
-  def create!(title:, body:, labels: nil)
+  # @param labels [Array<String>]
+  #   List of labels. It is a optional parameter. You can add labels to the
+  #   created PR.
+  # @param project_column_name [String]
+  #   A project column name. It is a optional parameter. You can add the created
+  #   PR to the GitHub project.
+  # @param project_id [Integer]
+  #   A target project ID. It is a optional parameter. If does not supplied,
+  #   this method will find a project which associated the repository.
+  #   When the repository has multiple projects, you should supply this.
+  # @return [Boolean] Return true if it is successed.
+  # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/LineLength
+  def create!(title:, body:, labels: nil, project_column_name: nil, project_id: nil)
     return false unless git_condition_valid?
 
     git.push(github_token_url, topic_branch)
@@ -56,8 +67,14 @@ class PrComet
       base: base_branch, head: topic_branch, title: title, body: body
     )
     github.add_labels(pr_number, *labels) unless labels.nil?
+    unless project_column_name.nil?
+      github.add_to_project(
+        pr_number, column_name: project_column_name, project_id: project_id
+      )
+    end
     true
   end
+  # rubocop:enable Metrics/AbcSize, Metrics/MethodLength, Metrics/LineLength
 
   private
 

data/lib/pr_comet/command_line.rb

@@ -12,19 +12,9 @@ class PrComet
     def execute(command)
       puts "$ #{command}"
       `#{command}`.chomp.tap do |result|
-        color_code = $CHILD_STATUS.success? ? GREEN : RED
-        color_puts(result, color_code)
+        color = $CHILD_STATUS.success? ? :green : :red
+        puts Rainbow(result).color(color)
       end
     end
-
-    RED = 31
-    GREEN = 32
-    YELLOW = 33
-    BLUE = 34
-    PING = 35
-
-    def color_puts(string, color_code)
-      puts "\e[#{color_code}m#{string}\e[0m"
-    end
   end
 end

data/lib/pr_comet/errors.rb

@@ -2,6 +2,10 @@
 
 class PrComet
   module Errors
-    class ExistUncommittedModify < StandardError; end
+    # Common error class
+    class Error < StandardError; end
+
+    # Un-commited modify was detected on the local
+    class ExistUncommittedModify < Error; end
   end
 end

data/lib/pr_comet/github/client.rb

@@ -18,25 +18,93 @@ class PrComet
       # @param title [String] Title for the pull request
       # @param body [String] The body for the pull request
       # @return [Integer] Created pull request number
+      # @see http://octokit.github.io/octokit.rb/Octokit/Client/PullRequests.html#create_pull_request-instance_method
       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
+      # Add labels to the issue.
       #
       # @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
+      # @see http://octokit.github.io/octokit.rb/Octokit/Client/Labels.html#add_labels_to_an_issue-instance_method
       def add_labels(issue_number, *labels)
         client.add_labels_to_an_issue(repository, issue_number, labels)
       end
 
+      # Adds supplied issue (or pull request) to the GitHub project
+      #
+      # @param issue_number [Integer] Number ID of the issue (or pull request)
+      # @param column_name [String] A target column name
+      # @param project_id [Integer]
+      #   A target project ID. It is a optional parameter. If does not supplied,
+      #   this method will find a project which associated the repository.
+      #   When the repository has multiple projects, you should supply this.
+      # @see http://octokit.github.io/octokit.rb/Octokit/Client/Projects.html#create_project_card-instance_method
+      def add_to_project(issue_number, column_name:, project_id: nil)
+        project_id ||= default_project_id
+        column_id = get_project_column_id(project_id, column_name)
+        issue_id = get_issue_id(issue_number)
+        client.create_project_card(
+          column_id,
+          content_id: issue_id,
+          content_type: 'PullRequest'
+        )
+      rescue Octokit::Error => e
+        raise "Failed to add a pull request to the project: #{e.message}"
+      end
+
       private
 
       REPOSITORY_MATCHER = %r{github\.com[:/](?<repository>.+)\.git}.freeze
 
       attr_reader :client
+
+      # Returns a GitHub project column id which associated with supplied
+      # project ID and which matched with supplied column name. If does not
+      # found column, it returns nil.
+      #
+      # @param project_id [Integer] A target project ID
+      # @param column_name [String] A target column name
+      # @return [Integer, nil] Project column ID
+      def get_project_column_id(project_id, column_name)
+        find_project_columns(project_id).find { |c| c.name == column_name }.id
+      rescue StandardError
+        raise "Cannot find the GitHub project column with '#{column_name}'"
+      end
+
+      # Returns the issue (or pull request) ID
+      #
+      # @param issue_number [Integer] A target issue number
+      # @return [Integer] Issue ID
+      def get_issue_id(issue_number)
+        client.pull_request(repository, issue_number).id
+      end
+
+      # Finds a project id which associate with this repository.
+      # If found multiple projects it returns first one.
+      #
+      # @return [Integer] Project ID
+      # @raise [StandardError] Raises error when does not found a project.
+      # @see http://octokit.github.io/octokit.rb/Octokit/Client/Projects.html#projects-instance_method
+      def default_project_id
+        client.projects(repository).first.id
+      rescue Octokit::Error
+        raise 'Project does not found on this repository'
+      end
+
+      # Finds project columns with supplied project ID.
+      #
+      # @param project_id [Integer] A target project ID
+      # @return [Array<Sawyer::Resource>] List of project columns
+      # @see http://octokit.github.io/octokit.rb/Octokit/Client/Projects.html#project_columns-instance_method
+      def find_project_columns(project_id)
+        client.project_columns(project_id)
+      rescue Octokit::Error
+        raise "Project columns does not found at project_id:#{project_id}"
+      end
     end
   end
 end

data/lib/pr_comet/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class PrComet
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end

data/pr_comet.gemspec

@@ -23,6 +23,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_runtime_dependency 'octokit'
+  spec.add_runtime_dependency 'rainbow'
 
   spec.add_development_dependency 'bundler', '~> 1.16'
   spec.add_development_dependency 'pry-byebug'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pr_comet
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - ryz310
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-08 00:00:00.000000000 Z
+date: 2019-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: octokit
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '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: bundler
   requirement: !ruby/object:Gem::Requirement