linterbot 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dde45db3e73e3ec689bc1ef9aad6df01df8c763e
-  data.tar.gz: aa351f4a7146f00b5cb26c32dc3b9287fd0ba888
+  metadata.gz: a2f26a60af3c2daf0fd41d3de2bba31227e106c9
+  data.tar.gz: dd5127dee945ad434f69d3a1d8be4568b6fe6f3c
 SHA512:
-  metadata.gz: c022b7291ea41e832744c4980a1f920b2b4bd6b4dbdba4c203794e469bb636cb963354f0f61007d8ccf478c1d2c5ca6d793a0fb2d3496139bf4012dc955a0b07
-  data.tar.gz: 7a271ee4ef5a10dbfa63882b45b24b6fceaed72792ae3157293512fa34a0837e9b8dedffd348a3b24899e79795e5eda85d693b2f6b23492b1051ba49f2524db0
+  metadata.gz: fc79ca148abf04b7e64aef79bee6f13799c6636adc58112358d04cab86ce51e433f6d2ad69bb89ded7ed9d4ad68e94cfc37e4fed3b9b6d46e2444b4c0f44e1d7
+  data.tar.gz: 2789de7abf885410d298011b490af03ea10dce24d1034e81af058b6f9d53acea3c8704e9a11b5338c97f452dec5277de68fadf811b0c7199e2d134e47d7c9a66

data/README.md

@@ -1,6 +1,10 @@
 # Linterbot
 
-A bot that parses swiftlint output and analyzes a GitHub pull request. Then for each linter violation it will make comment in the pull request diff on the line where the violation was made.
+[![Gem Version](https://badge.fury.io/rb/linterbot.svg)](https://badge.fury.io/rb/linterbot)
+
+A bot that parses [SwiftLint](https://github.com/realm/SwiftLint) output and analyzes a GitHub pull request. Then for each linter violation it will make comment in the pull request diff on the line where the violation was made.
+
+![linterbot commenting on pull request](./docs/assets/linterbot-comment-pull-request.png)
 
 ## Installation
 
@@ -20,18 +24,74 @@ Or install it yourself as:
 
 ## Usage
 
-Locally
+### Locally
+
+If you want to try it locally:
 
 ```
 swiftlint --reporter json | linterbot REPOSITORY PULL_REQUEST_NUMBER
 ```
 
-In TravisCI
+### TravisCI
 
+If you want to run it in TravisCI for every pull request triggered build you can create a script (with execution permission) called `linter` with the following content:
+
+```bash
+#!/bin/bash
+
+if [ "$TRAVIS_PULL_REQUEST" != "false" ]
+then
+  swiftlint --reporter json > switlint-report.json || false
+  linterbot $TRAVIS_REPO_SLUG $TRAVIS_PULL_REQUEST < swiftlint-report
+fi
 ```
-swiftlint --reporter json | linterbot $TRAVIS_REPO_SLUG $TRAVIS_PULL_REQUEST
+*`|| false` avoids a build fail if there are severe lint error*
+
+Finally in your `.travis.yml` file:
+
+```yml
+language: objective-c
+osx_image: xcode7.2
+before_install:
+- gem install bundler
+- gem install linterbot
+- brew install swiftlint
+script:
+- linter
+- xcodebuild clean build test -project YourProject.xcodeproj -scheme YourProject
 ```
 
+For more help run:
+
+```
+linterbot -h
+```
+
+and if you want to check all the available options for the `run` command (which is the default command to be run if none is provided) then run:
+
+```
+linterbot help run
+```
+
+### GitHub access
+
+In order for linterbot to be able to comment on your pull request it needs write access to the specified repository. You can provided an access token by either using the environmental variable `GITHUB_ACCESS_TOKEN` or using the `.linterbot.yml` (which should not be committed to your git repository).
+
+### Configuration file
+
+You can define some configuration parameters in configuration file. By default `linterbot` will try to load `.linterbot.yml` from the current working directory. You can change it using the `--config-file-path` option.
+
+The following are the supported parameters you can configure in the `.linterbot.yml` file:
+
+```yml
+github_access_token: 'YOUR_GITHUB_ACCESS_TOKEN'
+linter_report_file: 'PATH/TO/SWIFTLINT/JSON/OUTPUT/FILE'
+project_base_path: 'BASE/PROJECT/PATH'
+```
+
+By default `linterbot` will read from the standard input the JSON output of the `swiftlint lint --reporter json` command. You can tell `linterbot` to read the `swiftlint` output from a specific file either using the `--linter-report-file-path` option or through the `.linterbot.yml` file.
+
+The base path of project must be provided. By default the current working directory where `linterbot` was executed is used. You can change it either using the `--project-base-path` or through the `.linterbot.yml` file.
 
 ## Development
 

data/lib/linterbot/commit_approver.rb

@@ -12,8 +12,8 @@ module Linterbot
       github_client.create_status(repository, sha, "success", context: context, description: approve_description)
     end
 
-    def reject(repository, sha)
-      github_client.create_status(repository, sha, "failure", context: context, description: reject_description)
+    def reject(repository, sha, serious_violations_count)
+      github_client.create_status(repository, sha, "failure", context: context, description: reject_description(serious_violations_count))
     end
 
     def pending(repository, sha)
@@ -34,8 +34,8 @@ module Linterbot
         "The pull request passed the linter validations!"
       end
 
-      def reject_description
-        "There are linter violations that must be fixed!"
+      def reject_description(serious_violations_count)
+        "There are #{serious_violations_count} serious linter violations that must be fixed!"
       end
 
   end

data/lib/linterbot/github_pull_request_commenter.rb

@@ -24,7 +24,11 @@ module Linterbot
     end
 
     def publish_summary(summary)
-      github_client.add_comment(repository, pull_request_number, summary)
+      if same_as_last_summary?(summary)
+        puts "Summary was not published because it's the same as the last result summary:\n #{summary}"
+      else
+        github_client.add_comment(repository, pull_request_number, summary)
+      end
     end
 
     private
@@ -42,17 +46,33 @@ module Linterbot
       end
 
       def comment_exist?(message)
-        existing_comments.find { |comment| comment.body == message && comment.user.id == bot_github_id }
+        existing_comments.find { |comment| same_comment?(comment, message) }
+      end
+
+      def existing_summaries
+        @existing_summaries ||= fetch_existing_comments("issue")
+      end
+
+      def latest_existing_comment
+        @latest_existing_comment ||= existing_summaries.sort { |a, b| b.created_at <=> a.created_at }.first
+      end
+
+      def same_as_last_summary?(summary)
+        latest_existing_comment && same_comment?(latest_existing_comment, summary)
+      end
+
+      def same_comment?(comment, message)
+        comment.body == message && comment.user.id == bot_github_id
       end
 
       def existing_comments
-        @existing_comments ||= fetch_existing_comments
+        @existing_comments ||= fetch_existing_comments("pull_request")
       end
 
-      def fetch_existing_comments
-        github_client.pull_request_comments(repository, pull_request_number).map do |comment|
+      def fetch_existing_comments(source)
+        github_client.send("#{source}_comments", repository, pull_request_number).map do |comment|
           user = OpenStruct.new(comment[:user].to_h)
-          OpenStruct.new(comment.to_h.merge(:user => user))
+          OpenStruct.new(comment.to_h.merge(user: user))
         end
       end
 

data/lib/linterbot/pull_request_analysis_result.rb

@@ -12,18 +12,30 @@ module Linterbot
       comments.empty?
     end
 
+    def violations?
+      comments.count > 0
+    end
+
     def violations_count
       comments.count
     end
 
     def summary
-      "Total linter violations in pull request: #{comments.count}\n" +
-      "Serious: #{serious_violations.count}\n" +
-      "Warnings: #{warning_violations.count}"
+      if violations?
+        "Total linter violations in pull request: #{comments.count}\n" +
+        "Serious: #{serious_violations.count}\n" +
+        "Warnings: #{warning_violations.count}"
+      else
+        ":+1: There are no linter violations."
+      end
+    end
+
+    def serious_violations_count
+      serious_violations.count
     end
 
     def serious_violations?
-      serious_violations.count > 0
+      serious_violations_count > 0
     end
 
     private

data/lib/linterbot/result_handler.rb

@@ -17,7 +17,7 @@ module Linterbot
       result.comments.each { |comment| commenter.publish_comment(comment) }
       commenter.publish_summary(result.summary)
       if result.serious_violations?
-        reject_pull_request
+        reject_pull_request(result.serious_violations_count)
       else
         approve_pull_request
       end

data/lib/linterbot/tty_approver.rb

@@ -9,8 +9,8 @@ module Linterbot
       puts approve_description
     end
 
-    def reject(repository, sha)
-      puts reject_description
+    def reject(repository, sha, serious_violations_count)
+      puts reject_description(serious_violations_count)
     end
 
     def pending(repository, sha)
@@ -25,8 +25,8 @@ module Linterbot
         "The pull request passed the linter validations!"
       end
 
-      def reject_description
-        "There are linter violations that must be fixed!"
+      def reject_description(serious_violations_count)
+        "There are #{serious_violations_count} serious linter violations that must be fixed!"
       end
 
   end

data/lib/linterbot/version.rb

@@ -1,3 +1,3 @@
 module Linterbot
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: linterbot
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Guido Marucci Blas
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-20 00:00:00.000000000 Z
+date: 2016-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -114,6 +114,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- docs/assets/linterbot-comment-pull-request.png
 - exe/linterbot
 - lib/linterbot.rb
 - lib/linterbot/comment.rb