lita-reviewme 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 65fb6f44ca8287b695119bbfc6cb40740c101891
-  data.tar.gz: a3cd8f88df4ac677ec17b61c5be16f90d4529178
+  metadata.gz: 314ab18b6586a16c2e317fbfb50ca9e1f3b7c945
+  data.tar.gz: 7fbc8906b146f332eac6e2330999240dccb7948e
 SHA512:
-  metadata.gz: d679f71503a9785d8d7df87ae9a8ee32ebcb1beac9cf028fec9f5f07458334753af167a89faec34aa09d5520e1ba82f39d21da69af6ec2fb557283350023e244
-  data.tar.gz: 3102217b8e66ab74496542dd93643e65431c4067525ab36f58467cb6e21856755b2b5d3871c0719274fa3fed9a935f14afe56dd4abb896132721a5a058db7da7
+  metadata.gz: b1f6090dd447abfbdd171e99e25b65cadadf33c277ecc3ff8f27da70fcf98effd75c2a5474b1de87ed1c6323641d0affdcaa69e4b7f2c43a7579cd532a943b3a
+  data.tar.gz: 74dc37d914c77454f1637dacf758aa3ccd8cd11ffe1235e4b795ff68ca305b4ff290d5e6a2710e8c01bb1de5ee03f0a475c36c05b260c2d1bb6fdbd5783ce829

data/CHANGELOG.md

@@ -4,6 +4,14 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+## [0.4.0] - 2017-02-10
+
+### Added
+- [#50] - Allow custom GitHub messages via plugin config
+
+### Fixed
+- [#51] - Avoid empty GitHub message when there are no reviewers
+
 ## [0.3.1] - 2016-02-10
 
 ### Changed
@@ -34,7 +42,8 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 ### Added
 - Start versioning gem.
 
-[Unreleased]: https://github.com/iamvery/lita-reviewme/compare/v0.3.1...HEAD
+[Unreleased]: https://github.com/iamvery/lita-reviewme/compare/v0.4.0...HEAD
+[0.4.0]: https://github.com/iamvery/lita-reviewme/compare/v0.3.1...v0.4.0
 [0.3.1]: https://github.com/iamvery/lita-reviewme/compare/v0.3.0...v0.3.1
 [0.3.0]: https://github.com/iamvery/lita-reviewme/compare/v0.2.0...v0.3.0
 [0.2.0]: https://github.com/iamvery/lita-reviewme/compare/v0.1.0...v0.2.0

data/README.md

@@ -26,6 +26,32 @@ Regardless the user must have access to the repo being reviewed, and the token m
 config.handlers.reviewme.github_access_token = ENV["GITHUB_ACCESS_TOKEN"]
 ```
 
+The default message that is posted on GitHub pull request is `:eyes: @<reviewer>`.
+The message can be customized via `config.handlers.reviewme.github_comment_template`.
+If you would like the reviewer to be notified, be sure add `%{reviewer}` to your string.
+
+```
+# your bot's lita_config.rb
+# Add %{reviewer} for the user to be tagged and notified on GitHub
+config.handlers.reviewme.github_comment_template = "Hey %{reviewer}, check it out! :tada:"
+```
+
+Additionally, you can assign a lambda if you would like more finite control of what GitHub comments are sent.
+Note that `reviewer` and `pull_request` are required arguments.
+
+```
+# your bot's lita_config.rb
+#
+# Note:
+# `reviewer` is a username string without the '@'
+# `pull_request` is a hash object from GitHub API.
+
+config.handlers.reviewme.github_comment_template = lamda do |reviewer, pull_request|
+  title = pull_request[:title]
+  "Hey #{reviewer}, check out my new PR called #{title} :tada:"
+end
+```
+
 ## Usage
 
 ### See who is in the review rotation.
@@ -63,6 +89,8 @@ to the repository.
 >
 > **Nerdbot** iamvery should be on it...
 
+If your Github user is different from your chat user, you might tweak your notification settings to include your Github username.
+
 ## License
 
 [MIT](http://opensource.org/licenses/MIT)

data/lib/lita/handlers/reviewme.rb

@@ -4,8 +4,10 @@ module Lita
   module Handlers
     class Reviewme < Handler
       REDIS_LIST = "reviewers"
+      DEFAULT_GITHUB_MSG = ":eyes: %{reviewer}"
 
       config :github_access_token
+      config :github_comment_template
 
       route(
         /add (.+) to reviews/i,
@@ -96,7 +98,8 @@ module Lita
         rescue Octokit::Error
           response.reply("Unable to check who issued the pull request. Sorry if you end up being assigned your own PR!")
         end
-        comment = github_comment(reviewer)
+        return response.reply('Sorry, no reviewers found') unless reviewer
+        comment = github_comment(reviewer, pull_request)
 
         begin
           github_client.add_comment(repo, id, comment)
@@ -119,8 +122,14 @@ module Lita
         ns_redis(room.id).rpoplpush(REDIS_LIST, REDIS_LIST)
       end
 
-      def github_comment(reviewer)
-        ":eyes: @#{reviewer}"
+      def github_comment(reviewer, pull_request)
+        msg = config.github_comment_template || DEFAULT_GITHUB_MSG
+
+        if msg.respond_to?(:call) # its a proc
+          msg.call(reviewer, pull_request)
+        else
+          msg % { reviewer: "@#{reviewer}" }
+        end
       end
 
       def github_client

data/lita-reviewme.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "lita-reviewme"
-  spec.version       = "0.3.1"
+  spec.version       = "0.4.0"
   spec.authors       = ["Jay Hayes"]
   spec.email         = ["ur@iamvery.com"]
   spec.description   = %q{A lita handler that helps with code review}

data/spec/lita/handlers/reviewme_spec.rb

@@ -56,7 +56,7 @@ describe Lita::Handlers::Reviewme, lita_handler: true do
     let(:repo) { "gh_user/repo" }
     let(:id) { "123" }
     let(:pr) do
-      OpenStruct.new({ user: OpenStruct.new({ login: "pr-owner" }) })
+      OpenStruct.new(user: OpenStruct.new(login: "pr-owner"), title: "PR title")
     end
 
     before do
@@ -65,6 +65,10 @@ describe Lita::Handlers::Reviewme, lita_handler: true do
         .and_return(pr)
     end
 
+    after do
+      subject.config.github_comment_template = nil
+    end
+
     it "posts comment on github" do
       expect_any_instance_of(Octokit::Client).to receive(:add_comment)
         .with(repo, id, ":eyes: @iamvery")
@@ -75,6 +79,47 @@ describe Lita::Handlers::Reviewme, lita_handler: true do
       expect(reply).to eq("iamvery should be on it...")
     end
 
+    it "does NOT post comment on github when there are no reviewers" do
+      expect_any_instance_of(Octokit::Client).to_not receive(:add_comment)
+
+      send_command("review https://github.com/#{repo}/pull/#{id}")
+
+      expect(reply).to eq("Sorry, no reviewers found")
+    end
+
+    it "posts custom comments on github if specified" do
+      custom_msg   = ":tada: %{reviewer} this is awesome"
+      expected_msg = ":tada: @iamvery this is awesome"
+      subject.config.github_comment_template = custom_msg
+
+      expect_any_instance_of(Octokit::Client).to receive(:add_comment)
+        .with(repo, id, expected_msg)
+
+      send_command("add iamvery to reviews")
+      send_command("review https://github.com/#{repo}/pull/#{id}")
+
+      expect(reply).to eq("iamvery should be on it...")
+    end
+
+    it "executes a proc if specified in `config.github_comment_template`" do
+      my_lambda = lambda do |reviewer, pull_request|
+        title = pull_request[:title]
+        "hey @#{reviewer}, this is from a lambda! :tada: #{title}"
+      end
+
+      expected_msg = "hey @iamvery, this is from a lambda! :tada: #{pr.title}"
+
+      subject.config.github_comment_template = my_lambda
+
+      expect_any_instance_of(Octokit::Client).to receive(:add_comment)
+        .with(repo, id, expected_msg)
+
+      send_command("add iamvery to reviews")
+      send_command("review https://github.com/#{repo}/pull/#{id}")
+
+      expect(reply).to eq("iamvery should be on it...")
+    end
+
     it "skips assigning to the GitHub PR owner" do
       expect_any_instance_of(Octokit::Client).to receive(:pull_request)
         .with(repo, id).and_return(pr)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lita-reviewme
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Jay Hayes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-10 00:00:00.000000000 Z
+date: 2017-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lita
@@ -141,7 +141,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: A lita handler that helps with code review