thegarage-gitx 2.10.0 → 2.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a3ba4526a6cb6a7cfa24ec14119448eb93802865
-  data.tar.gz: 5f98b2f487eb204dab8c060218580871d1873386
+  metadata.gz: c60254f8675c8326d671e96ac965f222eb007808
+  data.tar.gz: 398dd0103e3a51063e1ad5d9a88d06e6ca471569
 SHA512:
-  metadata.gz: 9689ecc4716c330e747e607a2d629d7f0613c52ad025c326d04aefcd33b5055bc16c450725c85af802754f5c6ef40a30b569087f72f85ccf824f057558e2ef7f
-  data.tar.gz: 0f5df20623851c98ead0d71f225dcb013c49ee86661fc9267d1b88154b8075ddd226b90c1484e4cb71b991e4592accb1bdd37c8a7d77ab1d88e9d4575c9cea69
+  metadata.gz: 91de6e1d04a921889e24c80f80a39bad98c8ba7069c7781ac889870458967b6c163ad75059bd3ff823343a923418ea6a3e49d75a30ec13a49f7d8e2fd80829b5
+  data.tar.gz: e7d2fcdb382ba1fa9ba2562ced9b591c826e4a2ef22b40750fec4703a8e3748c7f71515d0ae7e6414711337ff2c4d4404f1ac0bf7d67368e3f1318a588408d1b

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

@@ -10,22 +10,27 @@ module Thegarage
       class ReviewCommand < BaseCommand
         include Thegarage::Gitx::Github
 
-        BUMP_COMMENT_TEMPLATE = <<-EOS.dedent
-          [gitx] review bump :tada:
-
-          ### Changelog Summary
+        BUMP_COMMENT_PREFIX = '[gitx] review bump :tada:'
+        BUMP_COMMENT_FOOTER = <<-EOS.dedent
+          # Bump comments should include:
+          # * summary of what changed
+          #
+          # This footer will automatically be stripped from the created comment
         EOS
-        APPROVAL_COMMENT_TEMPLATE = <<-EOS.dedent
-          [gitx] review approved :shipit:
-
-          ### Feedback
-
-          ### Follow-up Items
+        APPROVAL_COMMENT_PREFIX  = '[gitx] review approved :shipit:'
+        APPROVAL_COMMENT_FOOTER = <<-EOS.dedent
+          # Approval comments can include:
+          # * feedback
+          # * post-release follow-up items
+          #
+          # This footer will automatically be stripped from the created comment
         EOS
-        REJECTION_COMMENT_TEMPLATE = <<-EOS.dedent
-          [gitx] review rejected
-
-          ### Feedback
+        REJECTION_COMMENT_PREFIX = '[gitx] review rejected'
+        REJECTION_COMMENT_FOOTER = <<-EOS.dedent
+          # Rejection comments should include:
+          # * feedback for fixes required before approved
+          #
+          # This footer will automatically be stripped from the created comment
         EOS
 
         desc "review", "Create or update a pull request on github"
@@ -65,29 +70,25 @@ module Thegarage
         end
 
         def bump_pull_request(pull_request)
-          comment = get_editor_input(BUMP_COMMENT_TEMPLATE)
-          github_client.add_comment(github_slug, pull_request.number, comment)
-
+          comment = comment_from_template(pull_request, BUMP_COMMENT_PREFIX, BUMP_COMMENT_FOOTER)
           set_review_status('pending', 'Peer review in progress')
         end
 
         def reject_pull_request(pull_request)
-          comment = get_editor_input(REJECTION_COMMENT_TEMPLATE)
-          github_client.add_comment(github_slug, pull_request.number, comment)
-
+          comment = comment_from_template(pull_request, REJECTION_COMMENT_PREFIX, REJECTION_COMMENT_FOOTER)
           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)
-
+          comment = comment_from_template(pull_request, APPROVAL_COMMENT_PREFIX, APPROVAL_COMMENT_FOOTER)
           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
+        def comment_from_template(pull_request, prefix, footer)
+          text = ask_editor("\n\n#{footer}", repo.config['core.editor'])
+          comment = [prefix, text].join("\n\n")
+          comment = comment.gsub(footer, '').chomp.strip
+          github_client.add_comment(github_slug, pull_request.number, comment)
         end
 
         def set_review_status(state, description)

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

@@ -18,7 +18,7 @@ class Thor
     # see http://rdoc.info/github/visionmedia/commander/master/Commander/UI.ask_editor
     def ask_editor(initial_text = '', editor = nil)
       editor ||= ENV['EDITOR'] || 'vi'
-      Tempfile.open('reviewrequest.md') do |f|
+      Tempfile.open('comment.md') do |f|
         f << initial_text
         f.flush
 

data/lib/thegarage/gitx/version.rb

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

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

@@ -138,7 +138,7 @@ describe Thegarage::Gitx::Cli::ReviewCommand do
       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 description'})
+          with(body: {body: "[gitx] review bump :tada:\n\ncomment 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').
@@ -165,7 +165,7 @@ describe Thegarage::Gitx::Cli::ReviewCommand do
       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'})
+          with(body: {body: "[gitx] review rejected\n\ncomment 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').
@@ -192,7 +192,7 @@ describe Thegarage::Gitx::Cli::ReviewCommand do
       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'})
+          with(body: {body: "[gitx] review approved :shipit:\n\ncomment 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').

metadata

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