reviewlette 0.0.9 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 163d81e853831b82b114bf4705a4b89621e308dc
-  data.tar.gz: 75186e2b3813ee25c38b8ebdf60df1c9a5205171
+  metadata.gz: fc2e0db8f1f84d6d27f7057eecdb21a24aab3f7e
+  data.tar.gz: b7e681c5a4954a09144b509b5434a649b9c378a4
 SHA512:
-  metadata.gz: 4daa9c0f5d7e62f4dc08604b66a6b8888b3ae5d6ca4486ac29d67cff05bec0ea9d5e7659e682b3107562e7021ac665e0d25e4955d067d4729e64c3d8a1d572ed
-  data.tar.gz: 56f797d47df14a587b4b3bbfe99ad5290e345565c47548adb33f5d11641cc6fefdcd62f413798ad974d07bea0a3340f44a293a5684e44cea224b8c5d21e5e7f4
+  metadata.gz: 21647bb1f08a246343b1c3cb8920a668f87cbe2c461affaeceec60bb57f3d2c0f1c39357c4bcf77ae0419ff150a46ff8f6db9f21842c175cd5a3731f04af12ed
+  data.tar.gz: f4e2ac2ca8900f6a195d284d32e6e001751ee79528f8d0bbfdf899334f8e54e5bde6d96388892cc741cd2e928cfc8af743c512e1d1091eeb139cc59530a38791

data/.dockerignore

@@ -0,0 +1 @@
+/config/

data/.travis.yml

@@ -1,5 +1,5 @@
 language: ruby
 rvm:
-  - "2.0.0"
+  - "2.3.1"
 # uncomment this line if your project needs to run something other than `rake`:
-# script: bundle exec rspec spec
+# script: bundle exec rspec spec

data/Gemfile

@@ -1,24 +1,21 @@
 source 'http://rubygems.org'
 
-gem 'json'
-gem 'haml'
-gem 'octokit', '~> 3.8.0'
-gem 'ruby-trello'
-gem 'rdoc'
-gem 'rspec'
-gem 'webmock'
-gem 'rake'
-gem 'ap'
-gem 'byebug'
-gem 'simplecov'
-gem 'prophet'
-gem 'coveralls'
-gem 'sequel'
-gem 'sqlite3'
+gemspec
 
+group :development, :test do
+  gem 'ap'
+  gem 'rake'
+  gem 'debugger-linecache'
+  gem 'byebug'
+end
 
-group :development do
+group :test do
+  gem 'rspec'
+  gem 'webmock'
   gem 'guard'
   gem 'guard-rspec'
   gem 'libnotify'
+  gem 'simplecov'
+  gem 'coveralls'
+  gem 'rdoc'
 end

data/Gemfile.lock

@@ -1,42 +1,47 @@
+PATH
+  remote: .
+  specs:
+    reviewlette (1.0.0)
+      octokit
+      ruby-trello
+
 GEM
   remote: http://rubygems.org/
   specs:
-    activemodel (4.1.1)
-      activesupport (= 4.1.1)
-      builder (~> 3.1)
-    activesupport (4.1.1)
-      i18n (~> 0.6, >= 0.6.9)
-      json (~> 1.7, >= 1.7.7)
+    activemodel (5.0.0.1)
+      activesupport (= 5.0.0.1)
+    activesupport (5.0.0.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
       minitest (~> 5.1)
-      thread_safe (~> 0.1)
       tzinfo (~> 1.1)
-    addressable (2.3.8)
+    addressable (2.5.0)
+      public_suffix (~> 2.0, >= 2.0.2)
     ap (0.1.1)
       httparty (>= 0.7.7)
-    builder (3.2.2)
-    byebug (3.1.2)
-      columnize (~> 0.8)
-    celluloid (0.16.0)
-      timers (~> 4.0.0)
-    coderay (1.1.0)
-    columnize (0.8.9)
-    coveralls (0.7.0)
-      multi_json (~> 1.3)
-      rest-client
-      simplecov (>= 0.7)
-      term-ansicolor
-      thor
-    crack (0.4.2)
+    byebug (9.0.6)
+    coderay (1.1.1)
+    concurrent-ruby (1.0.2)
+    coveralls (0.8.17)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.12.0)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.1)
+      tins (~> 1.6)
+    crack (0.4.3)
       safe_yaml (~> 1.0.0)
+    debugger-linecache (1.2.0)
     diff-lcs (1.2.5)
-    docile (1.1.3)
-    faraday (0.9.1)
+    docile (1.1.5)
+    domain_name (0.5.20161129)
+      unf (>= 0.0.5, < 1.0.0)
+    faraday (0.10.0)
       multipart-post (>= 1.2, < 3)
-    ffi (1.9.8)
+    ffi (1.9.14)
     formatador (0.2.5)
-    guard (2.12.6)
+    guard (2.14.0)
       formatador (>= 0.2.4)
-      listen (~> 2.7)
+      listen (>= 2.7, < 4.0)
       lumberjack (~> 1.0)
       nenv (~> 0.1)
       notiffany (~> 0.0)
@@ -44,97 +49,96 @@ GEM
       shellany (~> 0.0)
       thor (>= 0.18.1)
     guard-compat (1.2.1)
-    guard-rspec (4.5.2)
+    guard-rspec (4.7.3)
       guard (~> 2.1)
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
-    haml (4.0.5)
-      tilt
-    hitimes (1.2.2)
-    httparty (0.13.1)
-      json (~> 1.8)
+    hashdiff (0.3.1)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    httparty (0.14.0)
       multi_xml (>= 0.5.2)
-    i18n (0.6.9)
-    json (1.8.1)
+    i18n (0.7.0)
+    json (2.0.2)
     libnotify (0.9.1)
       ffi (>= 1.0.11)
-    listen (2.10.1)
-      celluloid (~> 0.16.0)
-      rb-fsevent (>= 0.9.3)
-      rb-inotify (>= 0.9)
-    lumberjack (1.0.9)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    lumberjack (1.0.10)
     method_source (0.8.2)
-    mime-types (2.3)
-    minitest (5.3.4)
-    multi_json (1.10.0)
-    multi_xml (0.5.5)
+    mime-types (2.99.3)
+    minitest (5.10.1)
+    multi_xml (0.6.0)
     multipart-post (2.0.0)
-    nenv (0.2.0)
-    notiffany (0.0.6)
+    nenv (0.3.0)
+    netrc (0.11.0)
+    notiffany (0.1.1)
       nenv (~> 0.1)
       shellany (~> 0.0)
-    oauth (0.4.7)
-    octokit (3.8.0)
-      sawyer (~> 0.6.0, >= 0.5.3)
-    prophet (1.5.5)
-      octokit
-      rspec
-    pry (0.10.1)
+    oauth (0.5.1)
+    octokit (4.6.2)
+      sawyer (~> 0.8.0, >= 0.5.3)
+    pry (0.10.4)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
       slop (~> 3.4)
-    rake (10.3.2)
-    rb-fsevent (0.9.5)
-    rb-inotify (0.9.5)
+    public_suffix (2.0.4)
+    rake (12.0.0)
+    rb-fsevent (0.9.8)
+    rb-inotify (0.9.7)
       ffi (>= 0.5.0)
-    rdoc (4.1.1)
-      json (~> 1.4)
-    rest-client (1.6.7)
-      mime-types (>= 1.16)
-    rspec (3.0.0)
-      rspec-core (~> 3.0.0)
-      rspec-expectations (~> 3.0.0)
-      rspec-mocks (~> 3.0.0)
-    rspec-core (3.0.0)
-      rspec-support (~> 3.0.0)
-    rspec-expectations (3.0.0)
+    rdoc (5.0.0)
+    rest-client (1.8.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.0.0)
-    rspec-mocks (3.0.0)
-      rspec-support (~> 3.0.0)
-    rspec-support (3.0.0)
-    ruby-trello (1.1.1)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    ruby-trello (1.5.1)
       activemodel (>= 3.2.0)
       addressable (~> 2.3)
       json
-      oauth (~> 0.4.5)
-      rest-client (~> 1.6.7)
-    safe_yaml (1.0.3)
-    sawyer (0.6.0)
-      addressable (~> 2.3.5)
-      faraday (~> 0.8, < 0.10)
-    sequel (4.13.0)
+      oauth (>= 0.4.5)
+      rest-client (~> 1.8.0)
+    ruby_dep (1.5.0)
+    safe_yaml (1.0.4)
+    sawyer (0.8.1)
+      addressable (>= 2.3.5, < 2.6)
+      faraday (~> 0.8, < 1.0)
     shellany (0.0.1)
-    simplecov (0.8.2)
+    simplecov (0.12.0)
       docile (~> 1.1.0)
-      multi_json
-      simplecov-html (~> 0.8.0)
-    simplecov-html (0.8.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
     slop (3.6.0)
-    sqlite3 (1.3.9)
-    term-ansicolor (1.3.0)
+    term-ansicolor (1.4.0)
       tins (~> 1.0)
-    thor (0.19.1)
-    thread_safe (0.3.4)
-    tilt (2.0.1)
-    timers (4.0.1)
-      hitimes
-    tins (1.1.0)
-    tzinfo (1.2.1)
+    thor (0.19.4)
+    thread_safe (0.3.5)
+    tins (1.13.0)
+    tzinfo (1.2.2)
       thread_safe (~> 0.1)
-    webmock (1.18.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.2)
+    webmock (2.3.1)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
+      hashdiff
 
 PLATFORMS
   ruby
@@ -143,21 +147,16 @@ DEPENDENCIES
   ap
   byebug
   coveralls
+  debugger-linecache
   guard
   guard-rspec
-  haml
-  json
   libnotify
-  octokit (~> 3.8.0)
-  prophet
   rake
   rdoc
+  reviewlette!
   rspec
-  ruby-trello
-  sequel
   simplecov
-  sqlite3
   webmock
 
 BUNDLED WITH
-   1.10.6
+   1.13.6

data/README.md

@@ -1,43 +1,43 @@
-Reviewlette
-===========
-
-[![Coverage Status](https://img.shields.io/coveralls/jschmid1/reviewlette.svg)](https://coveralls.io/r/jschmid1/reviewlette)
-[![Code Climate](https://codeclimate.com/github/jschmid1/reviewlette.png)](https://codeclimate.com/github/jschmid1/reviewlette)
-
-Tool to automatically assign a "Reviewer" to a GitHub Issue and to the attached Trello Card.
+[![Code Climate](https://codeclimate.com/github/SUSE/reviewlette.png)](https://codeclimate.com/github/SUSE/reviewlette)
+[![Build Status](https://secure.travis-ci.org/SUSE/reviewlette.png?branch=master)](https://travis-ci.org/SUSE/reviewlette)
 
+# Reviewlette
+Tool to automatically assign reviewers to GitHub pull requests and to move and comment on their Trello cards.
 
 What it does:
 
-- Finds unassigned issues on GitHub.
-- Assigns a member of your team.
-- Locates the right Card on Trello.
-- Checks if the assignee is on vacation(using tel).
-- Adds the assigned member to the Card.
-- Move the card to 'In review'
-
+- Finds pull requests with missing reviewers in your GitHub repos.
+- Assigns random members of your team.
+- Locates the right card in your Trello board.
+- Mentions the assigned reviewer in a comment on the card.
+- Moves the card to the 'In review' column.
 
 ## Installation
+For the latest and greatest version you should `git clone https://github.com/SUSE/reviewlette`
 
+## Usage
+```ruby
+Reviewlette.new(members: User.all, github_config: {}, trello_config: {}).run
 ```
-gem install reviewlette
-reviewlette
-```
-
 
-## Setup
+Users must respond to `trello_handle` and `github_handle` methods.
 
-#### Name your pullrequest like so:
-#### Review_#23_name_of_review_42  <= trello card number
+Examples for `github_config` and `trello_config` can be found in `config/`.
 
-Fill `config/.trello.yml` (instructions in the file)
-Fill `config/.github.yml` (instructions in the file
+### Matching Trello cards
+To match a Trello card to a pull request, its title has to end with the card number (not the id)
 
+#### Example:
 
----
+URL of the Trello card: _https://trello.com/c/cardid/4242-fix-everything_
 
-[Using Octokit as a GitHub api wrapper](https://github.com/octokit/octokit.rb)
-[Using ruby-trello as a Trello api wrapper](https://github.com/jeremytregunna/ruby-trello)
+Pull request title should be: `Fix almost everything 4242`
 
+__Note:__ Pull requests without a matching Trello card get skipped and won't be assigned to a reviewer.
 
+### Labels
+You can tweak Reviewlette's behavior by adding special labels to your pull request:
 
+| Label       | Description          |
+|-------------|----------------------|
+| 2 reviewers | Assign two reviewers |

data/config/github_example.yml

@@ -1,5 +1,4 @@
-# generate the token here: https://github.com/settings/tokens/new
-
-token:
-  repos: ["SUSE/connect", "SUSE/happy-customer", "SUSE/reviewlette", "SUSE/scc-docker-images",
-    "SUSE/scc-provisioning", "SUSE/scc-token", "SUSE/TeamDashboard" ]
+token: # generate the token here: https://github.com/settings/tokens/new
+repos:
+  - user/repo1
+  - org/repo2

data/lib/reviewlette.rb

@@ -1,15 +1,12 @@
 require 'reviewlette/trello_connection'
 require 'reviewlette/github_connection'
-require 'reviewlette/vacations'
 require 'yaml'
 
-VERSION = '0.0.9'
-
 class Reviewlette
-  def initialize
-    @trello  = TrelloConnection.new
-    @members = YAML.load_file("#{File.dirname(__FILE__)}/../config/members.yml")
-    @github  = YAML.load_file("#{File.dirname(__FILE__)}/../config/github.yml")
+  def initialize(members:, github_config: nil, trello_config: nil)
+    @trello  = TrelloConnection.new(trello_config)
+    @github  = github_config || YAML.load_file("#{File.dirname(__FILE__)}/../config/github.yml")
+    @members = members
   end
 
   def run
@@ -27,12 +24,20 @@ class Reviewlette
       return
     end
 
-    repo.unassigned_pull_requests.each do |issue|
-      issue_id    = issue[:number]
+    repo.pull_requests.each do |issue|
+      issue_id = issue[:number]
       issue_title = issue[:title]
+      issue_labels = repo.labels(issue_id)
+
+      puts "*** Checking GitHub pull request: #{issue_title}"
+      matched = issue_title.match(/\d+[_'"]?$/)
+
+      unless matched
+        puts 'Pull request not assigned to a trello card'
+        next
+      end
 
-      puts "*** Checking unassigned github pull request: #{issue_title}"
-      card_id = issue_title.split(/[_ -#\.]/).last.to_i
+      card_id = matched[0].to_i
       card    = @trello.find_card_by_id(card_id)
 
       unless card
@@ -41,35 +46,38 @@ class Reviewlette
       end
 
       puts "Found matching trello card: #{card.name}"
-      reviewer = select_reviewer(issue, card)
 
-      unless reviewer
-        puts "Could not find a reviewer for card: #{card.name}"
-        next
+      assignees = issue[:assignees].map(&:login)
+      already_assigned_members = @members.select { |m| assignees.include? m.github_handle }
+      wanted_number = how_many_should_review(issue_labels)
+
+      if assignees.size < wanted_number
+        reviewers = select_reviewers(card, wanted_number, already_assigned_members)
+        if reviewers.empty?
+          puts "Could not find a reviewer for card: #{card.name}"
+          next
+        end
+        repo.add_assignees(issue_id, reviewers.map { |r| r.github_handle } )
+        repo.comment_reviewers(issue_id, reviewers, card)
+        @trello.comment_reviewers(card, repo_name, issue_id, reviewers)
+        @trello.move_card_to_list(card, 'In review')
+        already_assigned_members
       end
 
-      repo.add_assignee(issue_id, reviewer['github_username'])
-      repo.reviewer_comment(issue_id, reviewer['github_username'], card)
-      comment = "@#{reviewer['trello_username']} will review https://github.com/#{repo_name}/issues/#{issue_id}"
 
-      @trello.comment_on_card(comment, card)
-      @trello.move_card_to_list(card, 'In review')
     end
   end
 
-  def select_reviewer(issue, card)
-    reviewers = @members['members']
-
-    # remove people on vacation
-    members_on_vacation = Vacations.members_on_vacation(reviewers)
+  def select_reviewers(card, number = 1, already_assigned = [])
+    reviewers = @members
+    reviewers.reject! { |r| card.members.map(&:username).include? r.trello_handle }
+    reviewers -= already_assigned
 
-    reviewers = reviewers.reject {|r| members_on_vacation.include? r['suse_username'] }
-
-    # remove trello card owner
-    reviewers = reviewers.reject {|r| card.members.map(&:username).include? r['trello_username'] }
-    reviewer = reviewers.sample
-    puts "Selected reviewer: #{reviewer['name']} from pool #{reviewers.map {|r| r['name'] }}" if reviewer
-    reviewer
+    reviewers.sample(number - already_assigned.size) + already_assigned
   end
 
+  def how_many_should_review(labels)
+    return 2 if labels.include? '2 reviewers'
+    1
+  end
 end