pronto 0.8.2 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fcfa0272ff5c7843fd8324ad6501712d4b44f0d2
-  data.tar.gz: 9307ded530f2ff112a815288f26eef50d4c94980
+  metadata.gz: 099138cee32a88a8f83065a6fc4c270da56a7a6d
+  data.tar.gz: 623bb35ba84b91ba174d1d50cd89ef9fa4a808a7
 SHA512:
-  metadata.gz: 7005406729f52f4f2e8c350be4c3cb061a1c38d3647eb006f17079f62c375149615e8d748766a310e277d0057cd67dcf6ba7bc07cd4958ce07b2231733bd47ee
-  data.tar.gz: 43b1369e95053918c26518c41f6f2bfb310edfc7d028d8a2067c0c69ce5872c77cacbadfee602c783ef37afd39f62f0d69de461b8ea93a8e1fcc5bc60f0bc021
+  metadata.gz: 4aab1e003de4850796ccb246d9a19e1cd3af73672846bfb1f6aa0480c3601b975922bd12d2d8138ab2a5d3422e0493934b472a7dd6ea39837e7b03bd0c205471
+  data.tar.gz: 9c06c011e43bd2e0c82f685182502b7f292d8bb4954fab1fcba4a9b1ac1cd6bd55df86940d778d34f7e52e032cbd52da43bd72d8bec609fbc5fcb71e08330ccc

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 # Changelog
 
+## 0.9.0
+
+### New features
+
+* [#206](https://github.com/mmozuras/pronto/pull/216): add Bitbucket Server pull request formatter.
+* [#204](https://github.com/mmozuras/pronto/pull/204): add ability configure message format for each formatter.
+* [#111](https://github.com/mmozuras/pronto/issues/111): add `--staged` option for `pronto run` to analyze staged changes.
+* [#217](https://github.com/mmozuras/pronto/issues/217): add GitHub pull request review formatter.
+
+### Changes
+
+* [#193](https://github.com/mmozuras/pronto/issues/193): rename `pronto run --index` option to `--unstaged`.
+* [#49](https://github.com/mmozuras/pronto/issues/49): handle non-existance of GitHub pull requests gracefully.
+* [#217](https://github.com/mmozuras/pronto/issues/217): depend on `octokit >= 4.7.0`.
+* [#224](https://github.com/mmozuras/pronto/issues/224): depend on `gitlab >= 4.0.0`.
+* [#222](https://github.com/mmozuras/pronto/pull/184): prefix PULL_REQUEST_ID env variable with `PRONTO_`.
+
+### Bugs fixed
+
+* [#215](https://github.com/mmozuras/pronto/pull/215): an exclusion of files for single runner led to those files being excluded for all runners.
+
 ## 0.8.2
 
 ### Bugs fixed
@@ -10,7 +31,7 @@
 
 ### Changes
 
-* Add a default GitLab API endpoint: https://gitlab.com/api/v3
+* Add a default GitLab API endpoint: https://gitlab.com/api/v3.
 
 ### Bugs fixed
 

data/CONTRIBUTING.md

@@ -22,6 +22,7 @@ do so.
 * Use a topic/feature branch to easily amend a pull request later, if necessary.
 * Write [good commit messages][3].
 * Use the same coding conventions as the rest of the project.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally. You can also test your version of pronto locally with the help of `gem build` and `gem install`.
 * Commit and push until you are happy with your contribution.
 * Open a [pull request][4] that relates to *only* one subject with a clear title
   and description in grammatically correct, complete sentences.

data/README.md

@@ -1,18 +1,21 @@
 # Pronto
 
-[![Code Climate](https://codeclimate.com/github/mmozuras/pronto.svg)](https://codeclimate.com/github/mmozuras/pronto)
 [![Build Status](https://secure.travis-ci.org/mmozuras/pronto.svg)](http://travis-ci.org/mmozuras/pronto)
+[![Coverage Status](https://img.shields.io/codeclimate/coverage/github/mmozuras/pronto.svg)](https://codeclimate.com/github/mmozuras/pronto)
+[![Code Climate](https://codeclimate.com/github/mmozuras/pronto.svg)](https://codeclimate.com/github/mmozuras/pronto)
 [![Gem Version](https://badge.fury.io/rb/pronto.svg)](http://badge.fury.io/rb/pronto)
 [![Dependency Status](https://gemnasium.com/mmozuras/pronto.svg)](https://gemnasium.com/mmozuras/pronto)
 [![Inline docs](http://inch-ci.org/github/mmozuras/pronto.svg)](http://inch-ci.org/github/mmozuras/pronto)
 
 **Pronto** runs analysis quickly by checking only the relevant changes. Created to
 be used on [GitHub pull requests](#github-integration), but also works [locally](#local-changes) and integrates with [GitLab](#gitlab-integration) and [Bitbucket](#bitbucket-integration).
-Perfect if want to find out quickly if branch introduces changes that conform
+Perfect if you want to find out quickly if a branch introduces changes that conform
 to your [styleguide](https://github.com/mmozuras/pronto-rubocop), [are DRY](https://github.com/mmozuras/pronto-flay), [don't introduce security holes](https://github.com/mmozuras/pronto-brakeman) and [more](#runners).
 
 ![Pronto demo](pronto.gif "")
 
+_This README might be ahead of the latest release. Find the README for v0.9.0 [here](https://github.com/mmozuras/pronto/blob/v0.9.0/README.md)._
+
 * [Installation](#installation)
 * [Usage](#usage)
     * [Local Changes](#local-changes)
@@ -63,8 +66,11 @@ git checkout feature/branch
 # Analyze diff of committed changes on current branch and master:
 pronto run
 
+# Analyze changes in git staging area
+pronto run --staged
+
 # Analyze diff of uncommitted changes and master:
-pronto run --index
+pronto run --unstaged
 
 # Analyze *all* changes since the *initial* commit (may take some time):
 pronto run --commit=$(git log --pretty=format:%H | tail -1)
@@ -78,7 +84,8 @@ Available Options
 |:------------------|:------------------------------------------------------------|
 | `--exit-code`     | Exits with non-zero code if there were any warnings/errors. |
 | `-c/--commit`     | Commit for the diff.                                        |
-| `-i/--index`      | Analyze changes in git index (staging area).                |
+| `--staged`        | Analyze changes in git staging area                         |
+| `--unstaged`      | Analyze changes made, but not in git staging area           |
 | `-r/--runner`     | Run only the passed runners.                                |
 | `-f/--formatters` | Pick output formatters.                                     |
 
@@ -114,7 +121,7 @@ It's possible to combine multiple formatters.
 To get both pull request comments and commit status summary use:
 
 ```sh
-$ PRONTO_GITHUB_ACCESS_TOKEN=token PULL_REQUEST_ID=id pronto run -f github_status github_pr -c origin/master
+$ PRONTO_GITHUB_ACCESS_TOKEN=token PRONTO_PULL_REQUEST_ID=id pronto run -f github_status github_pr -c origin/master
 ```
 
 As an alternative, you can also set up a rake task:
@@ -207,6 +214,43 @@ via environment variables. Their names will be the upcased path to the property.
 For example: `PRONTO_GITHUB_SLUG` or `PRONTO_GITLAB_API_PRIVATE_TOKEN`. Environment variables
 will always take precedence over values in configuration file.
 
+### Message format
+
+Pronto allows you to configure the format of the messages that are produced. You
+can set a default format that will be used by all formatters, or you can
+configure a separate format per formatter, if you are using several.
+
+To change the default format:
+
+```yaml
+format: "%{runner} %{level} %{msg}"
+```
+
+To add the title of the Runner to the GitHub Pull Request formatter only:
+
+```yaml
+github_pr:
+  format: "%{runner} - %{msg}"
+```
+
+The available values to be interpolated into the message are:
+
+| Key          | Description    |
+|--------------|----------------|
+| `path`       | File path.     |
+| `line`       | Line number.   |
+| `level`      | Message level. |
+| `msg`        | Message.       |
+| `commit_sha` | SHA.           |
+| `runner`     | Runner name.   |
+
+The following values are available only to the text formatter:
+
+| Key              | Description              |
+|------------------|--------------------------|
+| `color_level`    | Colorized message level. |
+| `color_location` | Colorized location.      |
+
 ## Runners
 
 Pronto can run various tools and libraries, as long as there's a runner for it.
@@ -228,6 +272,7 @@ Currently available:
 * [pronto-jshint](https://github.com/mmozuras/pronto-jshint)
 * [pronto-json](https://github.com/deees/pronto-json)
 * [pronto-luacheck](https://github.com/seikichi/pronto-luacheck)
+* [pronto-perl_lint](https://github.com/bells17/pronto-perl_lint)
 * [pronto-phpcs](https://github.com/EllisV/pronto-phpcs)
 * [pronto-phpmd](https://github.com/EllisV/pronto-phpmd)
 * [pronto-poper](https://github.com/mmozuras/pronto-poper)
@@ -258,6 +303,7 @@ Articles to help you to get started:
 * [Automated Elixir code review with Github, Credo and Travis CI](https://medium.com/fazibear/automated-elixir-code-review-with-github-credo-and-travis-ci-986cd56b8f02)
 * [Running Rubocop before git commit](https://christoph.luppri.ch/articles/2016/11/21/running-rubocop-before-git-commit/)
 * [Pronto, Codeship and GitHub for automatic code review](http://abinoam.tl1n.com/pronto-codeship-and-github-for-automatic-code-review/)
+* [How to automatically review your PRs for style violations with Pronto and RuboCop](https://christoph.luppri.ch/articles/2017/03/05/how-to-automatically-review-your-prs-for-style-violations-with-pronto-and-rubocop/)
 
 Make a Pull Request to add something you wrote or found useful.
 

data/lib/pronto.rb

@@ -5,6 +5,8 @@ require 'forwardable'
 require 'httparty'
 require 'rainbow'
 
+require 'pronto/error'
+
 require 'pronto/gem_names'
 
 require 'pronto/logger'
@@ -12,6 +14,7 @@ require 'pronto/config_file'
 require 'pronto/config'
 
 require 'pronto/clients/bitbucket_client'
+require 'pronto/clients/bitbucket_server_client'
 
 require 'pronto/git/repository'
 require 'pronto/git/patches'
@@ -24,11 +27,14 @@ require 'pronto/comment'
 require 'pronto/status'
 require 'pronto/runner'
 require 'pronto/runners'
+require 'pronto/client'
 require 'pronto/github'
 require 'pronto/gitlab'
 require 'pronto/bitbucket'
+require 'pronto/bitbucket_server'
 
 require 'pronto/formatter/colorizable'
+require 'pronto/formatter/base'
 require 'pronto/formatter/text_formatter'
 require 'pronto/formatter/json_formatter'
 require 'pronto/formatter/git_formatter'
@@ -37,9 +43,11 @@ require 'pronto/formatter/pull_request_formatter'
 require 'pronto/formatter/github_formatter'
 require 'pronto/formatter/github_status_formatter'
 require 'pronto/formatter/github_pull_request_formatter'
+require 'pronto/formatter/github_pull_request_review_formatter'
 require 'pronto/formatter/gitlab_formatter'
 require 'pronto/formatter/bitbucket_formatter'
 require 'pronto/formatter/bitbucket_pull_request_formatter'
+require 'pronto/formatter/bitbucket_server_pull_request_formatter'
 require 'pronto/formatter/checkstyle_formatter'
 require 'pronto/formatter/null_formatter'
 require 'pronto/formatter/formatter'

data/lib/pronto/bitbucket.rb

@@ -1,12 +1,5 @@
 module Pronto
-  class Bitbucket
-    def initialize(repo)
-      @repo = repo
-      @config = Config.new
-      @comment_cache = {}
-      @pull_id_cache = {}
-    end
-
+  class Bitbucket < Client
     def pull_comments(sha)
       @comment_cache["#{pull_id}/#{sha}"] ||= begin
         client.pull_comments(slug, pull_id).map do |comment|
@@ -58,16 +51,12 @@ module Pronto
     end
 
     def pull_id
-      pull ? pull.id.to_i : env_pull_id.to_i
-    end
-
-    def env_pull_id
-      ENV['PULL_REQUEST_ID']
+      pull ? pull.id.to_i : env_pull_id
     end
 
     def pull
       @pull ||= if env_pull_id
-                  pull_requests.find { |pr| pr.id.to_i == env_pull_id.to_i }
+                  pull_requests.find { |pr| pr.id.to_i == env_pull_id }
                 elsif @repo.branch
                   pull_requests.find do |pr|
                     pr.source['branch']['name'] == @repo.branch

data/lib/pronto/bitbucket_server.rb

@@ -0,0 +1,33 @@
+module Pronto
+  class BitbucketServer < Bitbucket
+    def pull_comments(sha)
+      @comment_cache["#{pull_id}/#{sha}"] ||= begin
+        client.pull_comments(slug, pull_id).map do |comment|
+          anchor = comment['commentAnchor']
+          if anchor
+            Comment.new(sha, comment['comment']['text'],
+                        anchor['path'], anchor['line'])
+          end
+        end.compact
+      end
+    end
+
+    private
+
+    def client
+      @client ||= BitbucketServerClient.new(@config.bitbucket_username,
+                                            @config.bitbucket_password,
+                                            @config.bitbucket_api_endpoint)
+    end
+
+    def pull
+      @pull ||= if env_pull_id
+                  pull_requests.find { |pr| pr.id.to_i == env_pull_id }
+                elsif @repo.branch
+                  pull_requests.find do |pr|
+                    pr['fromRef']['displayId'] == @repo.branch
+                  end
+                end
+    end
+  end
+end

data/lib/pronto/cli.rb

@@ -24,10 +24,14 @@ module Pronto
                   aliases: '-c',
                   desc: 'Commit for the diff'
 
-    method_option :index,
+    method_option :unstaged,
                   type: :boolean,
-                  aliases: '-i',
-                  desc: 'Analyze changes in git index (staging area)'
+                  aliases: ['-i', '--index'],
+                  desc: 'Analyze changes made, but not in git staging area'
+
+    method_option :staged,
+                  type: :boolean,
+                  desc: 'Analyze changes in git staging area'
 
     method_option :runner,
                   type: :array,
@@ -48,7 +52,10 @@ module Pronto
       end
 
       formatters = ::Pronto::Formatter.get(options[:formatters])
-      commit = options[:index] ? :index : options[:commit]
+
+      commit_options = %i[staged unstaged index]
+      commit = commit_options.find { |o| options[o] } || options[:commit]
+
       repo_workdir = ::Rugged::Repository.discover('.').workdir
       messages = Dir.chdir(repo_workdir) do
         ::Pronto.run(commit, '.', formatters, path)
@@ -59,6 +66,8 @@ module Pronto
       end
     rescue Rugged::RepositoryError
       puts '"pronto" should be run from a git repository'
+    rescue Pronto::Error => e
+      $stderr.puts "Pronto errored: #{e.message}"
     end
 
     desc 'list', 'Lists pronto runners that are available to be used'
@@ -68,14 +77,14 @@ module Pronto
     end
 
     desc 'version', 'Display version'
-    map %w(-v --version) => :version
+    map %w[-v --version] => :version
 
     def version
       puts Version::STRING
     end
 
     desc 'verbose-version', 'Display verbose version'
-    map %w(-V --verbose-version) => :verbose_version
+    map %w[-V --verbose-version] => :verbose_version
 
     def verbose_version
       puts Version.verbose

data/lib/pronto/client.rb

@@ -0,0 +1,19 @@
+module Pronto
+  class Client
+    def initialize(repo)
+      @repo = repo
+      @config = Config.new
+      @comment_cache = {}
+      @pull_id_cache = {}
+    end
+
+    def env_pull_id
+      if (pull_request = ENV['PULL_REQUEST_ID'])
+        warn "[DEPRECATION] `PULL_REQUEST_ID` is deprecated.  Please use `PRONTO_PULL_REQUEST_ID` instead."
+      end
+
+      pull_request ||= ENV['PRONTO_PULL_REQUEST_ID']
+      pull_request.to_i if pull_request
+    end
+  end
+end

data/lib/pronto/clients/bitbucket_client.rb

@@ -3,41 +3,40 @@ class BitbucketClient
   base_uri 'https://api.bitbucket.org/1.0/repositories'
 
   def initialize(username, password)
-    credentials = { username: username, password: password }
-    @headers = { basic_auth: credentials }
+    self.class.basic_auth(username, password)
   end
 
   def commit_comments(slug, sha)
-    response = self.class.get("/#{slug}/changesets/#{sha}/comments", @headers)
-    openstruct(response.parsed_response)
+    response = get("/#{slug}/changesets/#{sha}/comments")
+    openstruct(response)
   end
 
   def create_commit_comment(slug, sha, body, path, position)
-    options = {
-      body: {
-        content: body,
-        line_to: position,
-        filename: path
-      }
-    }
-    options.merge!(@headers)
-    self.class.post("/#{slug}/changesets/#{sha}/comments", options)
+    post("/#{slug}/changesets/#{sha}/comments", body, path, position)
   end
 
-  def pull_comments(slug, pr_id)
-    url = "/#{slug}/pullrequests/#{pr_id}/comments"
-    response = self.class.get(url, @headers)
-    openstruct(response.parsed_response)
+  def pull_comments(slug, pull_id)
+    response = get("/#{slug}/pullrequests/#{pull_id}/comments")
+    openstruct(response)
   end
 
   def pull_requests(slug)
     base = 'https://api.bitbucket.org/2.0/repositories'
-    url = "#{base}/#{slug}/pullrequests?state=OPEN"
-    response = self.class.get(url, @headers)
-    openstruct(response.parsed_response['values'])
+    response = get("#{base}/#{slug}/pullrequests?state=OPEN")
+    openstruct(response['values'])
   end
 
   def create_pull_comment(slug, pull_id, body, path, position)
+    post("/#{slug}/pullrequests/#{pull_id}/comments", body, path, position)
+  end
+
+  private
+
+  def openstruct(response)
+    response.map { |r| OpenStruct.new(r) }
+  end
+
+  def post(url, body, path, position)
     options = {
       body: {
         content: body,
@@ -45,11 +44,10 @@ class BitbucketClient
         filename: path
       }
     }
-    options.merge!(@headers)
-    self.class.post("/#{slug}/pullrequests/#{pull_id}/comments", options)
+    self.class.post(url, options)
   end
 
-  def openstruct(response)
-    response.map { |r| OpenStruct.new(r) }
+  def get(url)
+    self.class.get(url).parsed_response
   end
 end

data/lib/pronto/clients/bitbucket_server_client.rb

@@ -0,0 +1,67 @@
+class BitbucketServerClient
+  include HTTParty
+
+  def initialize(username, password, endpoint)
+    self.class.base_uri(endpoint)
+    self.class.basic_auth(username, password)
+    @headers = { 'Content-Type' => 'application/json' }
+  end
+
+  def pull_comments(slug, pull_id)
+    url = "#{pull_requests_url(slug)}/#{pull_id}/activities"
+    response = paged_request(url)
+    response.select { |activity| activity.action == 'COMMENTED' }
+  end
+
+  def pull_requests(slug)
+    paged_request(pull_requests_url(slug), state: 'OPEN')
+  end
+
+  def create_pull_comment(slug, pull_id, body, path, position)
+    url = "#{pull_requests_url(slug)}/#{pull_id}/comments"
+    post(url, body, path, position)
+  end
+
+  private
+
+  def pull_requests_url(slug)
+    project_key, repository_key = slug.split('/')
+    "/projects/#{project_key}/repos/#{repository_key}/pull-requests"
+  end
+
+  def openstruct(response)
+    response.map { |r| OpenStruct.new(r) }
+  end
+
+  def paged_request(url, query = {})
+    Enumerator.new do |yielder|
+      next_page_start = 0
+      loop do
+        response = get(url, query.merge(start: next_page_start))
+        break if response['values'].nil?
+
+        response['values'].each { |item| yielder << OpenStruct.new(item) }
+
+        next_page_start = response['nextPageStart']
+        break unless next_page_start
+      end
+    end
+  end
+
+  def post(url, body, path, position)
+    body = {
+      text: body,
+      anchor: {
+        line: position,
+        lineType: 'ADDED',
+        path: path,
+        srcPath: path
+      }
+    }
+    self.class.post(url, body: body.to_json, headers: @headers)
+  end
+
+  def get(url, query)
+    self.class.get(url, query).parsed_response
+  end
+end

data/lib/pronto/config.rb

@@ -4,7 +4,7 @@ module Pronto
       @config_hash = config_hash
     end
 
-    %w(github gitlab bitbucket).each do |service|
+    %w[github gitlab bitbucket].each do |service|
       ConfigFile::EMPTY[service].each do |key, _|
         name = "#{service}_#{key}"
         define_method(name) { ENV["PRONTO_#{name.upcase}"] || @config_hash[service][key] }
@@ -43,6 +43,15 @@ module Pronto
       ENV['PRONTO_MAX_WARNINGS'] || @config_hash['max_warnings']
     end
 
+    def message_format(formatter)
+      formatter_config = @config_hash[formatter]
+      if formatter_config && formatter_config.key?('format')
+        formatter_config['format']
+      else
+        ENV['PRONTO_FORMAT'] || @config_hash['format']
+      end
+    end
+
     def logger
       @logger ||= begin
         verbose = ENV['PRONTO_VERBOSE'] || @config_hash['verbose']

data/lib/pronto/config_file.rb

@@ -1,5 +1,7 @@
 module Pronto
   class ConfigFile
+    DEFAULT_MESSAGE_FORMAT = '%{msg}'.freeze
+
     EMPTY = {
       'all' => {
         'exclude' => [],
@@ -20,12 +22,17 @@ module Pronto
         'slug' => nil,
         'username' => nil,
         'password' => nil,
+        'api_endpoint' => nil,
         'web_endpoint' => 'https://bitbucket.org/'
       },
+      'text' => {
+        'format' => '%{color_location} %{color_level}: %{msg}'
+      },
       'runners' => [],
       'formatters' => [],
       'max_warnings' => nil,
-      'verbose' => false
+      'verbose' => false,
+      'format' => DEFAULT_MESSAGE_FORMAT
     }.freeze
 
     def initialize(path = '.pronto.yml')

data/lib/pronto/error.rb

@@ -0,0 +1,3 @@
+module Pronto
+  class Error < StandardError; end
+end

data/lib/pronto/formatter/base.rb

@@ -0,0 +1,13 @@
+module Pronto
+  module Formatter
+    class Base
+      def self.name
+        Formatter::FORMATTERS.invert[self]
+      end
+
+      def config
+        @config ||= Config.new
+      end
+    end
+  end
+end

data/lib/pronto/formatter/bitbucket_server_pull_request_formatter.rb

@@ -0,0 +1,17 @@
+module Pronto
+  module Formatter
+    class BitbucketServerPullRequestFormatter < PullRequestFormatter
+      def client_module
+        BitbucketServer
+      end
+
+      def pretty_name
+        'BitBucket Server'
+      end
+
+      def line_number(message, _)
+        message.line.line.new_lineno if message.line
+      end
+    end
+  end
+end

data/lib/pronto/formatter/checkstyle_formatter.rb

@@ -2,7 +2,7 @@ require 'rexml/document'
 
 module Pronto
   module Formatter
-    class CheckstyleFormatter
+    class CheckstyleFormatter < Base
       def initialize
         @output = ''
       end

data/lib/pronto/formatter/commit_formatter.rb

@@ -1,7 +1,7 @@
 module Pronto
   module Formatter
     class CommitFormatter < GitFormatter
-      def existing_comments(messages, client, repo)
+      def existing_comments(messages, client, _)
         shas = messages.map(&:commit_sha)
         comments = shas.flat_map { |sha| client.commit_comments(sha) }
         grouped_comments(comments)

data/lib/pronto/formatter/formatter.rb

@@ -14,9 +14,11 @@ module Pronto
       'github' => GithubFormatter,
       'github_status' => GithubStatusFormatter,
       'github_pr' => GithubPullRequestFormatter,
+      'github_pr_review' => GithubPullRequestReviewFormatter,
       'gitlab' => GitlabFormatter,
       'bitbucket' => BitbucketFormatter,
       'bitbucket_pr' => BitbucketPullRequestFormatter,
+      'bitbucket_server_pr' => BitbucketServerPullRequestFormatter,
       'json' => JsonFormatter,
       'checkstyle' => CheckstyleFormatter,
       'text' => TextFormatter,

data/lib/pronto/formatter/git_formatter.rb

@@ -1,6 +1,6 @@
 module Pronto
   module Formatter
-    class GitFormatter
+    class GitFormatter < Base
       def format(messages, repo, patches)
         client = client_module.new(repo)
         existing = existing_comments(messages, client, repo)
@@ -39,10 +39,6 @@ module Pronto
         comments.group_by { |comment| [comment.path, comment.position] }
       end
 
-      def config
-        @config ||= Config.new
-      end
-
       def consolidate_comments(comments)
         comment = comments.first
         if comments.length > 1
@@ -55,7 +51,7 @@ module Pronto
 
       def dedupe_comments(existing, comments)
         body = existing.map(&:body).join(' ')
-        comments.select { |comment| !body.include?(comment.body) }
+        comments.reject { |comment| body.include?(comment.body) }
       end
 
       def join_comments(comments)
@@ -65,7 +61,9 @@ module Pronto
       def new_comment(message, patches)
         config.logger.log("Creating a comment from message: #{message.inspect}")
         sha = message.commit_sha
-        body = message.msg
+
+        body = config.message_format(self.class.name) % message.to_h
+
         path = message.path
         lineno = line_number(message, patches) if message.line
         Comment.new(sha, body, path, lineno)

data/lib/pronto/formatter/github_pull_request_review_formatter.rb

@@ -0,0 +1,24 @@
+module Pronto
+  module Formatter
+    class GithubPullRequestReviewFormatter < PullRequestFormatter
+      def client_module
+        Github
+      end
+
+      def pretty_name
+        'GitHub'
+      end
+
+      def submit_comments(client, comments)
+        client.create_pull_request_review(comments)
+      rescue Octokit::UnprocessableEntity, HTTParty::Error => e
+        $stderr.puts "Failed to post: #{e.message}"
+      end
+
+      def line_number(message, patches)
+        line = patches.find_line(message.full_path, message.line.new_lineno)
+        line.position
+      end
+    end
+  end
+end

data/lib/pronto/formatter/json_formatter.rb

@@ -2,7 +2,7 @@ require 'json'
 
 module Pronto
   module Formatter
-    class JsonFormatter
+    class JsonFormatter < Base
       def format(messages, _, _)
         messages.map do |message|
           lineno = message.line.new_lineno if message.line

data/lib/pronto/formatter/null_formatter.rb

@@ -1,8 +1,7 @@
 module Pronto
   module Formatter
-    class NullFormatter
-      def format(_, _, _)
-      end
+    class NullFormatter < Base
+      def format(_, _, _); end
     end
   end
 end

data/lib/pronto/formatter/pull_request_formatter.rb

@@ -1,7 +1,7 @@
 module Pronto
   module Formatter
     class PullRequestFormatter < GitFormatter
-      def existing_comments(messages, client, repo)
+      def existing_comments(_, client, repo)
         sha = repo.head_commit_sha
         comments = client.pull_comments(sha)
         grouped_comments(comments)

data/lib/pronto/formatter/text_formatter.rb

@@ -1,45 +1,15 @@
+require 'pronto/formatter/text_message_decorator'
+
 module Pronto
   module Formatter
-    class TextFormatter
-      include Colorizable
-
-      LOCATION_COLOR = :cyan
-
-      LEVEL_COLORS = {
-        info: :yellow,
-        warning: :magenta,
-        error: :red,
-        fatal: :red
-      }.freeze
-
+    class TextFormatter < Base
       def format(messages, _, _)
         messages.map do |message|
-          "#{format_location(message)} #{format_level(message)}: #{message.msg}".strip
-        end
-      end
-
-      private
-
-      def format_location(message)
-        line = message.line
-        lineno = line.new_lineno if line
-        path = message.path
-        commit_sha = message.commit_sha
-
-        if path || lineno
-          path = colorize(path, LOCATION_COLOR) if path
-          "#{path}:#{lineno}"
-        elsif commit_sha
-          colorize(commit_sha[0..6], LOCATION_COLOR)
+          message_format = config.message_format(self.class.name)
+          message_data = TextMessageDecorator.new(message).to_h
+          (message_format % message_data).strip
         end
       end
-
-      def format_level(message)
-        level = message.level
-        color = LEVEL_COLORS.fetch(level)
-
-        colorize(level[0].upcase, color)
-      end
     end
   end
 end

data/lib/pronto/formatter/text_message_decorator.rb

@@ -0,0 +1,46 @@
+module Pronto
+  module Formatter
+    class TextMessageDecorator < SimpleDelegator
+      include Colorizable
+
+      LOCATION_COLOR = :cyan
+
+      LEVEL_COLORS = {
+        info: :yellow,
+        warning: :magenta,
+        error: :red,
+        fatal: :red
+      }.freeze
+
+      def to_h
+        original = __getobj__.to_h
+        original[:color_level] = format_level(__getobj__)
+        original[:color_location] = format_location(__getobj__)
+        original
+      end
+
+      private
+
+      def format_location(message)
+        line = message.line
+        lineno = line.new_lineno if line
+        path = message.path
+        commit_sha = message.commit_sha
+
+        if path || lineno
+          path = colorize(path, LOCATION_COLOR) if path
+          "#{path}:#{lineno}"
+        elsif commit_sha
+          colorize(commit_sha[0..6], LOCATION_COLOR)
+        end
+      end
+
+      def format_level(message)
+        level = message.level
+        color = LEVEL_COLORS.fetch(level)
+
+        colorize(level[0].upcase, color)
+      end
+    end
+  end
+end

data/lib/pronto/git/line.rb

@@ -6,6 +6,9 @@ module Pronto
       def_delegators :line, :addition?, :deletion?, :content, :new_lineno,
                      :old_lineno, :line_origin
 
+      COMPARISON_ATTRIBUTES = %i[content line_origin
+                                 old_lineno new_lineno].freeze
+
       def position
         hunk_index = patch.hunks.find_index { |h| h.header == hunk.header }
         line_index = patch.lines.find_index(line)
@@ -31,10 +34,9 @@ module Pronto
         return false if other.nil?
         return true if line.nil? && other.line.nil?
 
-        content == other.content &&
-          line_origin == other.line_origin &&
-          old_lineno == other.old_lineno &&
-          new_lineno == other.new_lineno
+        COMPARISON_ATTRIBUTES.all? do |attribute|
+          send(attribute) == other.send(attribute)
+        end
       end
 
       private

data/lib/pronto/git/patches.rb

@@ -15,8 +15,8 @@ module Pronto
         @patches.each(&block)
       end
 
-      def reject!(&block)
-        @patches.reject!(&block)
+      def reject(&block)
+        Pronto::Git::Patches.new(repo, commit, @patches.reject(&block))
       end
 
       def find_line(path, line)

data/lib/pronto/git/repository.rb

@@ -8,14 +8,18 @@ module Pronto
       end
 
       def diff(commit, options = nil)
-        if commit == :index
-          patches = @repo.index.diff(options)
-          Patches.new(self, head, patches)
-        else
-          merge_base = merge_base(commit)
-          patches = @repo.diff(merge_base, head, options)
-          Patches.new(self, merge_base, patches)
-        end
+        target, patches = case commit
+                          when :unstaged, :index
+                            [head, @repo.index.diff(options)]
+                          when :staged
+                            [head, @repo.head.target.diff(@repo.index, options)]
+                          else
+                            merge_base = merge_base(commit)
+                            patches = @repo.diff(merge_base, head, options)
+                            [merge_base, patches]
+                          end
+
+        Patches.new(self, target, patches)
       end
 
       def show_commit(sha)

data/lib/pronto/github.rb

@@ -1,12 +1,5 @@
 module Pronto
-  class Github
-    def initialize(repo)
-      @repo = repo
-      @config = Config.new
-      @comment_cache = {}
-      @pull_id_cache = {}
-    end
-
+  class Github < Client
     def pull_comments(sha)
       @comment_cache["#{pull_id}/#{sha}"] ||= begin
         client.pull_comments(slug, pull_id).map do |comment|
@@ -14,6 +7,10 @@ module Pronto
                       comment.position || comment.original_position)
         end
       end
+    rescue Octokit::NotFound => e
+      @config.logger.log("Error raised and rescued: #{e}")
+      msg = "Pull request for sha #{sha} with id #{pull_id} was not found."
+      raise Pronto::Error, msg
     end
 
     def commit_comments(sha)
@@ -41,12 +38,22 @@ module Pronto
       end
     end
 
+    def create_pull_request_review(comments)
+      options = {
+        event: 'COMMENT',
+        comments: comments.map do |c|
+          { path: c.path, position: c.position, body: c.body }
+        end
+      }
+      client.create_pull_request_review(slug, pull_id, options)
+    end
+
     def create_commit_status(status)
       sha = pull_sha || status.sha
       @config.logger.log("Creating comment status on #{sha}")
-      client.create_status(slug,
-                           sha,
-                           status.state, context: status.context, description: status.description)
+      client.create_status(slug, sha, status.state,
+                           context: status.context,
+                           description: status.description)
     end
 
     private
@@ -70,11 +77,7 @@ module Pronto
     end
 
     def pull_id
-      pull ? pull[:number].to_i : env_pull_id.to_i
-    end
-
-    def env_pull_id
-      ENV['PULL_REQUEST_ID']
+      pull ? pull[:number].to_i : env_pull_id
     end
 
     def pull_sha
@@ -83,7 +86,7 @@ module Pronto
 
     def pull
       @pull ||= if env_pull_id
-                  pull_requests.find { |pr| pr[:number].to_i == env_pull_id.to_i }
+                  pull_requests.find { |pr| pr[:number].to_i == env_pull_id }
                 elsif @repo.branch
                   pull_requests.find { |pr| pr[:head][:ref] == @repo.branch }
                 end

data/lib/pronto/gitlab.rb

@@ -1,11 +1,5 @@
 module Pronto
-  class Gitlab
-    def initialize(repo)
-      @repo = repo
-      @config = Config.new
-      @comment_cache = {}
-    end
-
+  class Gitlab < Client
     def commit_comments(sha)
       @comment_cache[sha.to_s] ||= begin
         client.commit_comments(slug, sha, per_page: 500).map do |comment|
@@ -26,11 +20,10 @@ module Pronto
     def slug
       return @config.gitlab_slug if @config.gitlab_slug
       @slug ||= begin
-        slug = @repo.remote_urls.map do |url|
+        @repo.remote_urls.map do |url|
           match = slug_regex(url).match(url)
           match[:slug] if match
         end.compact.first
-        URI.escape(slug, '/') if slug
       end
     end
 

data/lib/pronto/message.rb

@@ -2,7 +2,7 @@ module Pronto
   class Message
     attr_reader :path, :line, :level, :msg, :commit_sha, :runner
 
-    LEVELS = [:info, :warning, :error, :fatal].freeze
+    LEVELS = %i[info warning error fatal].freeze
 
     def initialize(path, line, level, msg, commit_sha = nil, runner = nil)
       unless LEVELS.include?(level)
@@ -40,10 +40,21 @@ module Pronto
       end
     end
 
+    def to_h
+      {
+        path: path,
+        line: line,
+        level: level,
+        msg: msg,
+        commit_sha: commit_sha,
+        runner: @runner && @runner.title
+      }
+    end
+
     private
 
     def comparison_attributes
-      line ? [:path, :msg, :level, :line] : [:path, :msg, :level, :commit_sha]
+      line ? %i[path msg level line] : %i[path msg level commit_sha]
     end
   end
 end

data/lib/pronto/runner.rb

@@ -5,6 +5,7 @@ module Pronto
     def initialize(patches, commit = nil)
       @patches = patches
       @commit = commit
+      @config = Config.new
     end
 
     def self.runners

data/lib/pronto/runners.rb

@@ -28,10 +28,9 @@ module Pronto
     def reject_excluded(excluded_files, patches)
       return patches unless excluded_files.any?
 
-      patches.reject! do |patch|
+      patches.reject do |patch|
         excluded_files.include?(patch.new_file_full_path.to_s)
       end
-      patches
     end
 
     def exceeds_max?(warnings)

data/lib/pronto/version.rb

@@ -1,6 +1,6 @@
 module Pronto
   module Version
-    STRING = '0.8.2'.freeze
+    STRING = '0.9.0'.freeze
 
     MSG = '%s (running on %s %s %s)'.freeze
 

data/pronto.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.platform = Gem::Platform::RUBY
   s.author = 'Mindaugas Mozūras'
   s.email = 'mindaugas.mozuras@gmail.com'
-  s.homepage = 'http://github.com/mmozuras/pronto'
+  s.homepage = 'https://github.com/mmozuras/pronto'
   s.summary = 'Pronto runs analysis by checking only the introduced changes'
   s.description = <<-EOF
     Pronto runs analysis quickly by checking only the relevant changes. Created
@@ -42,16 +42,17 @@ Gem::Specification.new do |s|
 
   s.add_runtime_dependency('rugged', '~> 0.24', '>= 0.23.0')
   s.add_runtime_dependency('thor', '~> 0.19.0')
-  s.add_runtime_dependency('octokit', '~> 4.3', '>= 4.1.0')
-  s.add_runtime_dependency('gitlab', '~> 3.6', '>= 3.4.0')
+  s.add_runtime_dependency('octokit', '~> 4.7', '>= 4.7.0')
+  s.add_runtime_dependency('gitlab', '~> 4.0', '>= 4.0.0')
   s.add_runtime_dependency('httparty', '>= 0.13.7', '< 0.15')
   s.add_runtime_dependency('rainbow', '~> 2.1')
-  s.add_development_dependency('rake', '~> 11.0')
+  s.add_development_dependency('rake', '~> 12.0')
   s.add_development_dependency('rspec', '~> 3.4')
   s.add_development_dependency('rspec-its', '~> 1.2')
   s.add_development_dependency('rspec-expectations', '~> 3.4')
   s.add_development_dependency('bundler', '~> 1.3')
-  s.add_development_dependency('simplecov', '~> 0.11')
+  s.add_development_dependency('simplecov', '~> 0.14')
   s.add_development_dependency('rubocop', '~> 0.47')
   s.add_development_dependency('pronto-rubocop', '~> 0.8.0')
+  s.add_development_dependency('codeclimate-test-reporter', '~> 1.0')
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pronto
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.9.0
 platform: ruby
 authors:
 - Mindaugas Mozūras
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-03 00:00:00.000000000 Z
+date: 2017-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rugged
@@ -50,40 +50,40 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.3'
+        version: '4.7'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.1.0
+        version: 4.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.3'
+        version: '4.7'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.1.0
+        version: 4.7.0
 - !ruby/object:Gem::Dependency
   name: gitlab
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '4.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: 4.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '4.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
@@ -124,14 +124,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -194,14 +194,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '0.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '0.14'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -230,6 +230,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description: |2
       Pronto runs analysis quickly by checking only the relevant changes. Created
       to be used on pull requests, but suited for other scenarios as well. Perfect
@@ -250,13 +264,19 @@ files:
 - bin/pronto
 - lib/pronto.rb
 - lib/pronto/bitbucket.rb
+- lib/pronto/bitbucket_server.rb
 - lib/pronto/cli.rb
+- lib/pronto/client.rb
 - lib/pronto/clients/bitbucket_client.rb
+- lib/pronto/clients/bitbucket_server_client.rb
 - lib/pronto/comment.rb
 - lib/pronto/config.rb
 - lib/pronto/config_file.rb
+- lib/pronto/error.rb
+- lib/pronto/formatter/base.rb
 - lib/pronto/formatter/bitbucket_formatter.rb
 - lib/pronto/formatter/bitbucket_pull_request_formatter.rb
+- lib/pronto/formatter/bitbucket_server_pull_request_formatter.rb
 - lib/pronto/formatter/checkstyle_formatter.rb
 - lib/pronto/formatter/colorizable.rb
 - lib/pronto/formatter/commit_formatter.rb
@@ -264,6 +284,7 @@ files:
 - lib/pronto/formatter/git_formatter.rb
 - lib/pronto/formatter/github_formatter.rb
 - lib/pronto/formatter/github_pull_request_formatter.rb
+- lib/pronto/formatter/github_pull_request_review_formatter.rb
 - lib/pronto/formatter/github_status_formatter.rb
 - lib/pronto/formatter/github_status_formatter/sentence.rb
 - lib/pronto/formatter/github_status_formatter/status_builder.rb
@@ -272,6 +293,7 @@ files:
 - lib/pronto/formatter/null_formatter.rb
 - lib/pronto/formatter/pull_request_formatter.rb
 - lib/pronto/formatter/text_formatter.rb
+- lib/pronto/formatter/text_message_decorator.rb
 - lib/pronto/gem_names.rb
 - lib/pronto/git/line.rb
 - lib/pronto/git/patch.rb
@@ -288,7 +310,7 @@ files:
 - lib/pronto/status.rb
 - lib/pronto/version.rb
 - pronto.gemspec
-homepage: http://github.com/mmozuras/pronto
+homepage: https://github.com/mmozuras/pronto
 licenses:
 - MIT
 metadata: {}