thegarage-gitx 2.9.0 → 2.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 967ed00a8d2bd8e358dc56481a1eeab9a96fc552
-  data.tar.gz: 71ef71cd36da70a4da6b07787d2d2342c8dfb280
+  metadata.gz: a3ba4526a6cb6a7cfa24ec14119448eb93802865
+  data.tar.gz: 5f98b2f487eb204dab8c060218580871d1873386
 SHA512:
-  metadata.gz: ec87914ebce4c62a3891e1d60b76033e601f13a9a57d7ab692ca49da2d165e2a56f9f35f8e5f83300ed47e0e0a05d464dc35174dc630a48a517f4face59311e3
-  data.tar.gz: 6fc4ea416852c8aec5af068cf3a5b2e4a66a5dc55aee9fdef99baa29e22fd76b6523758561fcbb55fbd72043a3166893079affe1d4f64137cfc91c79d1665f1e
+  metadata.gz: 9689ecc4716c330e747e607a2d629d7f0613c52ad025c326d04aefcd33b5055bc16c450725c85af802754f5c6ef40a30b569087f72f85ccf824f057558e2ef7f
+  data.tar.gz: 0f5df20623851c98ead0d71f225dcb013c49ee86661fc9267d1b88154b8075ddd226b90c1484e4cb71b991e4592accb1bdd37c8a7d77ab1d88e9d4575c9cea69

data/README.md

@@ -35,7 +35,11 @@ options:
 * `--assign` or `-a` = assign pull request to github user
 * `--open` or `-o` = open pull request in default web browser.
 * `--bump` or `-b` = bump an existing pull request by posting a comment to re-review new changes
+* `--approve` = approve/signoff on pull request (with optional feedback)
+* `--reject` = reject pull request (with details)
 
+NOTE: the `--bump` option will also update the pull request commit status to mark the branch as 'pending peer review'.
+This setting is cleared when a reviewer approves or rejects the pull request.
 
 ## git release
 

data/lib/thegarage/gitx/cli/integrate_command.rb

@@ -8,7 +8,7 @@ module Thegarage
   module Gitx
     module Cli
       class IntegrateCommand < BaseCommand
-        include Github
+        include Thegarage::Gitx::Github
         desc 'integrate', 'integrate the current branch into one of the aggregate development branches (default = staging)'
         method_option :resume, :type => :string, :aliases => '-r', :desc => 'resume merging of feature-branch'
         def integrate(integration_branch = 'staging')

data/lib/thegarage/gitx/cli/release_command.rb

@@ -10,7 +10,7 @@ module Thegarage
   module Gitx
     module Cli
       class ReleaseCommand < BaseCommand
-        include Github
+        include Thegarage::Gitx::Github
 
         desc 'release', 'release the current branch to production'
         method_option :cleanup, :type => :boolean, :desc => 'cleanup merged branches after release'

data/lib/thegarage/gitx/cli/review_command.rb

@@ -8,20 +8,42 @@ module Thegarage
   module Gitx
     module Cli
       class ReviewCommand < BaseCommand
-        include Github
+        include Thegarage::Gitx::Github
+
+        BUMP_COMMENT_TEMPLATE = <<-EOS.dedent
+          [gitx] review bump :tada:
+
+          ### Changelog Summary
+        EOS
+        APPROVAL_COMMENT_TEMPLATE = <<-EOS.dedent
+          [gitx] review approved :shipit:
+
+          ### Feedback
+
+          ### Follow-up Items
+        EOS
+        REJECTION_COMMENT_TEMPLATE = <<-EOS.dedent
+          [gitx] review rejected
+
+          ### Feedback
+        EOS
 
         desc "review", "Create or update a pull request on github"
         method_option :description, :type => :string, :aliases => '-d', :desc => 'pull request description'
         method_option :assignee, :type => :string, :aliases => '-a', :desc => 'pull request assignee'
         method_option :open, :type => :boolean, :aliases => '-o', :desc => 'open the pull request in a web browser'
         method_option :bump, :type => :boolean, :aliases => '-b', :desc => 'bump an existing pull request by posting a comment to re-review new changes'
+        method_option :approve, :type => :boolean, :desc => 'approve the pull request an post comment on pull request'
+        method_option :reject, :type => :boolean, :desc => 'reject the pull request an post comment on pull request'
         # @see http://developer.github.com/v3/pulls/
         def review
           fail 'Github authorization token not found' unless authorization_token
 
           branch = current_branch.name
           pull_request = find_or_create_pull_request(branch)
-          create_bump_comment(pull_request) if options[:bump]
+          bump_pull_request(pull_request) if options[:bump]
+          approve_pull_request(pull_request) if options[:approve]
+          reject_pull_request(pull_request) if options[:reject]
           assign_pull_request(pull_request) if options[:assignee]
 
           run_cmd "open #{pull_request.html_url}" if options[:open]
@@ -42,15 +64,35 @@ module Thegarage
           github_client.update_issue(github_slug, pull_request.number, title, body, options)
         end
 
-        def create_bump_comment(pull_request)
-          comment_template = []
-          comment_template << '[gitx] review bump :tada:'
-          comment_template << ''
-          comment_template << '### Summary of Changes'
+        def bump_pull_request(pull_request)
+          comment = get_editor_input(BUMP_COMMENT_TEMPLATE)
+          github_client.add_comment(github_slug, pull_request.number, comment)
+
+          set_review_status('pending', 'Peer review in progress')
+        end
 
-          comment = ask_editor(comment_template.join("\n"), repo.config['core.editor'])
-          comment = comment.chomp.strip
+        def reject_pull_request(pull_request)
+          comment = get_editor_input(REJECTION_COMMENT_TEMPLATE)
           github_client.add_comment(github_slug, pull_request.number, comment)
+
+          set_review_status('failure', 'Peer review rejected')
+        end
+
+        def approve_pull_request(pull_request)
+          comment = get_editor_input(APPROVAL_COMMENT_TEMPLATE)
+          github_client.add_comment(github_slug, pull_request.number, comment)
+
+          set_review_status('success', 'Peer review approved')
+        end
+
+        def get_editor_input(template)
+          text = ask_editor(template, repo.config['core.editor'])
+          text = text.chomp.strip
+        end
+
+        def set_review_status(state, description)
+          latest_commit = repo.head.target_id
+          update_review_status(latest_commit, state, description)
         end
       end
     end

data/lib/thegarage/gitx/extensions/string.rb

@@ -1,7 +1,8 @@
 class String
+  # @see http://api.rubyonrails.org/classes/String.html#method-i-strip_heredoc
   def undent
-    a = $1 if match(/\A(\s+)(.*\n)(?:\1.*\n)*\z/)
-    gsub(/^#{a}/,'')
+    indent = scan(/^[ \t]*(?=\S)/).min.size || 0
+    gsub(/^[ \t]{#{indent}}/, '')
   end
   alias :dedent :undent
 

data/lib/thegarage/gitx/github.rb

@@ -2,138 +2,142 @@ require 'octokit'
 
 module Thegarage
   module Gitx
-    module Cli
-      module Github
-        CLIENT_URL = 'https://github.com/thegarage/thegarage-gitx'
-        PULL_REQUEST_FOOTER = <<-EOS.dedent
-          # Pull Request Protips(tm):
-          # * Include description of how this change accomplishes the task at hand.
-          # * Use GitHub flavored Markdown http://github.github.com/github-flavored-markdown/
-          # * Review CONTRIBUTING.md for recommendations of artifacts, links, images, screencasts, etc.
-          #
-          # This footer will automatically be stripped from the pull request description
-        EOS
-
-        def find_or_create_pull_request(branch)
-          pull_request = find_pull_request(branch)
-          pull_request ||= begin
-            execute_command(UpdateCommand, :update)
-            pull_request = create_pull_request(branch)
-            say 'Created pull request: '
-            say pull_request.html_url, :green
-
-            pull_request
-          end
+    module Github
+      REVIEW_CONTEXT = 'peer_review'
+      CLIENT_URL = 'https://github.com/thegarage/thegarage-gitx'
+      PULL_REQUEST_FOOTER = <<-EOS.dedent
+        # Pull Request Protips(tm):
+        # * Include description of how this change accomplishes the task at hand.
+        # * Use GitHub flavored Markdown http://github.github.com/github-flavored-markdown/
+        # * Review CONTRIBUTING.md for recommendations of artifacts, links, images, screencasts, etc.
+        #
+        # This footer will automatically be stripped from the pull request description
+      EOS
+
+      def find_or_create_pull_request(branch)
+        pull_request = find_pull_request(branch)
+        pull_request ||= begin
+          execute_command(Thegarage::Gitx::Cli::UpdateCommand, :update)
+          pull_request = create_pull_request(branch)
+          say 'Created pull request: '
+          say pull_request.html_url, :green
+
           pull_request
         end
+        pull_request
+      end
 
-        # @return [Sawyer::Resource] data structure of pull request info if found
-        # @return nil if no pull request found
-        def find_pull_request(branch)
-          head_reference = "#{github_organization}:#{branch}"
-          params = {
-            head: head_reference,
-            state: 'open'
-          }
-          pull_requests = github_client.pull_requests(github_slug, params)
-          pull_requests.first
-        end
+      # @return [Sawyer::Resource] data structure of pull request info if found
+      # @return nil if no pull request found
+      def find_pull_request(branch)
+        head_reference = "#{github_organization}:#{branch}"
+        params = {
+          head: head_reference,
+          state: 'open'
+        }
+        pull_requests = github_client.pull_requests(github_slug, params)
+        pull_requests.first
+      end
 
-        # Get the current commit status of a branch
-        # @see https://developer.github.com/v3/repos/statuses/#get-the-combined-status-for-a-specific-ref
-        def branch_status(branch)
-          response = github_client.status(github_slug, branch)
-          response.state
-        end
+      # Get the current commit status of a branch
+      # @see https://developer.github.com/v3/repos/statuses/#get-the-combined-status-for-a-specific-ref
+      def branch_status(branch)
+        response = github_client.status(github_slug, branch)
+        response.state
+      end
 
-        # @see http://developer.github.com/v3/pulls/
-        def create_pull_request(branch)
-          say "Creating pull request for "
-          say "#{branch} ", :green
-          say "against "
-          say "#{Thegarage::Gitx::BASE_BRANCH} ", :green
-          say "in "
-          say github_slug, :green
-
-          title = branch
-          body = pull_request_body(branch)
-          github_client.create_pull_request(github_slug, Thegarage::Gitx::BASE_BRANCH, branch, title, body)
-        end
+      # Update build status with peer review status
+      def update_review_status(commit_sha, state, description)
+        github_client.create_status(github_slug, commit_sha, state, context: REVIEW_CONTEXT, description: description)
+      end
 
-        def pull_request_body(branch)
-          changelog = run_cmd("git log #{Thegarage::Gitx::BASE_BRANCH}...#{branch} --reverse --no-merges --pretty=format:'* %s%n%b'")
-          description = options[:description]
+      # @see http://developer.github.com/v3/pulls/
+      def create_pull_request(branch)
+        say "Creating pull request for "
+        say "#{branch} ", :green
+        say "against "
+        say "#{Thegarage::Gitx::BASE_BRANCH} ", :green
+        say "in "
+        say github_slug, :green
+
+        title = branch
+        body = pull_request_body(branch)
+        github_client.create_pull_request(github_slug, Thegarage::Gitx::BASE_BRANCH, branch, title, body)
+      end
 
-          description_template = []
-          description_template << "#{description}\n" if description
-          description_template << '### Changelog'
-          description_template << changelog
-          description_template << PULL_REQUEST_FOOTER
+      def pull_request_body(branch)
+        changelog = run_cmd("git log #{Thegarage::Gitx::BASE_BRANCH}...#{branch} --reverse --no-merges --pretty=format:'* %s%n%b'")
+        description = options[:description]
 
-          body = ask_editor(description_template.join("\n"), repo.config['core.editor'])
-          body.gsub(PULL_REQUEST_FOOTER, '').chomp.strip
-        end
+        description_template = []
+        description_template << "#{description}\n" if description
+        description_template << '### Changelog'
+        description_template << changelog
+        description_template << PULL_REQUEST_FOOTER
 
-        # token is cached in local git config for future use
-        # @return [String] auth token stored in git (current repo, user config or installed global settings)
-        # @see http://developer.github.com/v3/oauth/#scopes
-        # @see http://developer.github.com/v3/#user-agent-required
-        def authorization_token
-          auth_token = repo.config['thegarage.gitx.githubauthtoken']
-          return auth_token unless auth_token.to_s.blank?
-
-          auth_token = create_authorization
-          repo.config['thegarage.gitx.githubauthtoken'] = auth_token
-          auth_token
-        end
+        body = ask_editor(description_template.join("\n"), repo.config['core.editor'])
+        body.gsub(PULL_REQUEST_FOOTER, '').chomp.strip
+      end
 
-        def create_authorization
-          password = ask("Github password for #{username}: ", :echo => false)
-          say ''
-          client = Octokit::Client.new(login: username, password: password)
-          response = client.create_authorization(authorization_request_options)
-          response.token
-        end
+      # token is cached in local git config for future use
+      # @return [String] auth token stored in git (current repo, user config or installed global settings)
+      # @see http://developer.github.com/v3/oauth/#scopes
+      # @see http://developer.github.com/v3/#user-agent-required
+      def authorization_token
+        auth_token = repo.config['thegarage.gitx.githubauthtoken']
+        return auth_token unless auth_token.to_s.blank?
+
+        auth_token = create_authorization
+        repo.config['thegarage.gitx.githubauthtoken'] = auth_token
+        auth_token
+      end
 
-        def authorization_request_options
-          timestamp = Time.now.utc.strftime('%Y-%m-%dT%H:%M:%S%z')
-          client_name = "The Garage Git eXtensions - #{github_slug} #{timestamp}"
-          options = {
-            :scopes => ['repo'],
-            :note => client_name,
-            :note_url => CLIENT_URL
-          }
-          two_factor_auth_token = ask("Github two factor authorization token (if enabled): ", :echo => false)
-          say ''
-          options[:headers] = {'X-GitHub-OTP' => two_factor_auth_token} if two_factor_auth_token
-          options
-        end
+      def create_authorization
+        password = ask("Github password for #{username}: ", :echo => false)
+        say ''
+        client = Octokit::Client.new(login: username, password: password)
+        response = client.create_authorization(authorization_request_options)
+        response.token
+      end
 
-        def github_client
-          @client ||= Octokit::Client.new(:access_token => authorization_token)
-        end
+      def authorization_request_options
+        timestamp = Time.now.utc.strftime('%Y-%m-%dT%H:%M:%S%z')
+        client_name = "The Garage Git eXtensions - #{github_slug} #{timestamp}"
+        options = {
+          :scopes => ['repo'],
+          :note => client_name,
+          :note_url => CLIENT_URL
+        }
+        two_factor_auth_token = ask("Github two factor authorization token (if enabled): ", :echo => false)
+        say ''
+        options[:headers] = {'X-GitHub-OTP' => two_factor_auth_token} if two_factor_auth_token
+        options
+      end
 
-        # @return [String] github username (ex: 'wireframe') of the current github.user
-        # @raise error if github.user is not configured
-        def username
-          username = repo.config['github.user']
-          fail "Github user not configured.  Run: `git config --global github.user 'me@email.com'`" unless username
-          username
-        end
+      def github_client
+        @client ||= Octokit::Client.new(:access_token => authorization_token)
+      end
 
-        # @return the github slug for the current repository's remote origin url.
-        # @example
-        #   git@github.com:socialcast/thegarage/gitx.git #=> thegarage/gitx
-        # @example
-        #   https://github.com/socialcast/thegarage/gitx.git #=> thegarage/gitx
-        def github_slug
-          remote = repo.config['remote.origin.url']
-          remote.to_s.gsub(/\.git$/,'').split(/[:\/]/).last(2).join('/')
-        end
+      # @return [String] github username (ex: 'wireframe') of the current github.user
+      # @raise error if github.user is not configured
+      def username
+        username = repo.config['github.user']
+        fail "Github user not configured.  Run: `git config --global github.user 'me@email.com'`" unless username
+        username
+      end
 
-        def github_organization
-          github_slug.split('/').first
-        end
+      # @return the github slug for the current repository's remote origin url.
+      # @example
+      #   git@github.com:socialcast/thegarage/gitx.git #=> thegarage/gitx
+      # @example
+      #   https://github.com/socialcast/thegarage/gitx.git #=> thegarage/gitx
+      def github_slug
+        remote = repo.config['remote.origin.url']
+        remote.to_s.gsub(/\.git$/,'').split(/[:\/]/).last(2).join('/')
+      end
+
+      def github_organization
+        github_slug.split('/').first
       end
     end
   end

data/lib/thegarage/gitx/version.rb

@@ -1,5 +1,5 @@
 module Thegarage
   module Gitx
-    VERSION = '2.9.0'
+    VERSION = '2.10.0'
   end
 end

data/spec/thegarage/gitx/cli/review_command_spec.rb

@@ -44,9 +44,10 @@ describe Thegarage::Gitx::Cli::ReviewCommand do
 
         allow(cli).to receive(:authorization_token).and_return(authorization_token)
         expect(cli).to receive(:run_cmd).with("git log master...feature-branch --reverse --no-merges --pretty=format:'* %s%n%b'").and_return("* old commit\n\n* new commit").ordered
-        expect(cli).to receive(:ask_editor).with("### Changelog\n* old commit\n\n* new commit\n#{Thegarage::Gitx::Cli::Github::PULL_REQUEST_FOOTER}", anything).and_return('description')
+        expect(cli).to receive(:ask_editor).with("### Changelog\n* old commit\n\n* new commit\n#{Thegarage::Gitx::Github::PULL_REQUEST_FOOTER}", anything).and_return('description')
 
         stub_request(:post, 'https://api.github.com/repos/thegarage/thegarage-gitx/pulls').to_return(:status => 201, :body => new_pull_request.to_json, :headers => {'Content-Type' => 'application/json'})
+
         VCR.use_cassette('pull_request_does_not_exist') do
           cli.review
         end
@@ -124,9 +125,11 @@ describe Thegarage::Gitx::Cli::ReviewCommand do
         }
       end
       let(:authorization_token) { '123123' }
+      let(:reference) { double('fake reference', target_id: 'e12da4') }
       before do
         allow(cli).to receive(:authorization_token).and_return(authorization_token)
         expect(cli).to receive(:ask_editor).and_return('comment description')
+        allow(repo).to receive(:head).and_return(reference)
         stub_request(:post, /.*api.github.com.*/).to_return(:status => 201)
 
         VCR.use_cassette('pull_request_does_exist_with_success_status') do
@@ -137,6 +140,64 @@ describe Thegarage::Gitx::Cli::ReviewCommand do
         expect(WebMock).to have_requested(:post, "https://api.github.com/repos/thegarage/thegarage-gitx/issues/10/comments").
           with(body: {body: 'comment description'})
       end
+      it 'creates pending build status for latest commit' do
+        expect(WebMock).to have_requested(:post, 'https://api.github.com/repos/thegarage/thegarage-gitx/statuses/e12da4').
+          with(body: {state: 'pending', context: 'peer_review', description: 'Peer review in progress'})
+      end
+    end
+    context 'when --reject flag is passed' do
+      let(:options) do
+        {
+          reject: true
+        }
+      end
+      let(:authorization_token) { '123123' }
+      let(:reference) { double('fake reference', target_id: 'e12da4') }
+      before do
+        allow(cli).to receive(:authorization_token).and_return(authorization_token)
+        expect(cli).to receive(:ask_editor).and_return('comment body')
+        allow(repo).to receive(:head).and_return(reference)
+        stub_request(:post, /.*api.github.com.*/).to_return(:status => 201)
+
+        VCR.use_cassette('pull_request_does_exist_with_success_status') do
+          cli.review
+        end
+      end
+      it 'posts comment to github' do
+        expect(WebMock).to have_requested(:post, "https://api.github.com/repos/thegarage/thegarage-gitx/issues/10/comments").
+          with(body: {body: 'comment body'})
+      end
+      it 'creates failure build status for latest commit' do
+        expect(WebMock).to have_requested(:post, 'https://api.github.com/repos/thegarage/thegarage-gitx/statuses/e12da4').
+          with(body: {state: 'failure', context: 'peer_review', description: 'Peer review rejected'})
+      end
+    end
+    context 'when --approve flag is passed' do
+      let(:options) do
+        {
+          approve: true
+        }
+      end
+      let(:authorization_token) { '123123' }
+      let(:reference) { double('fake reference', target_id: 'e12da4') }
+      before do
+        allow(cli).to receive(:authorization_token).and_return(authorization_token)
+        expect(cli).to receive(:ask_editor).and_return('comment body')
+        allow(repo).to receive(:head).and_return(reference)
+        stub_request(:post, /.*api.github.com.*/).to_return(:status => 201)
+
+        VCR.use_cassette('pull_request_does_exist_with_success_status') do
+          cli.review
+        end
+      end
+      it 'posts comment to github' do
+        expect(WebMock).to have_requested(:post, "https://api.github.com/repos/thegarage/thegarage-gitx/issues/10/comments").
+          with(body: {body: 'comment body'})
+      end
+      it 'creates success build status for latest commit' do
+        expect(WebMock).to have_requested(:post, 'https://api.github.com/repos/thegarage/thegarage-gitx/statuses/e12da4').
+          with(body: {state: 'success', context: 'peer_review', description: 'Peer review approved'})
+      end
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: thegarage-gitx
 version: !ruby/object:Gem::Version
-  version: 2.9.0
+  version: 2.10.0
 platform: ruby
 authors:
 - Ryan Sonnek
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-10 00:00:00.000000000 Z
+date: 2014-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rugged