policial 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f9ea96661ceb59f07846827daf7ccf1d9f1ed2c6
-  data.tar.gz: 26d33c00ee9d4dfa3e65196f3faa6d8c4bfad416
+  metadata.gz: 0bd45df38f9f7a34cf66c40c590f6303f5da2ce9
+  data.tar.gz: 0b8b8e18e4d78f0af05fd3b7c9397e97bfb256fe
 SHA512:
-  metadata.gz: 59ea217f976c38a00fb0a80bac2fd23c73f592622efcef1e8689db454ced0e54365da3e9a459f0b0a1a26d6e34ae5c4e5a4105d748f90ccb16e98a20b7e1bf8e
-  data.tar.gz: 58be1670722255f6886aae39685cf7357406e4b1e74d97b752752faa682574b8d5914bd233ad9c32f8683197e33e79e38220062faf4144deb34a85ccd729ddd0
+  metadata.gz: d0fba5b32b0d423d8a087fd94748dc01ed583f0058dd23d76432521f6ad4c72f36e9ecef1a894f0af660800838fbf8f0a027b0bfe83410905b0b341359fa763b
+  data.tar.gz: d88ae791f713457b4bbc61a0b2ea8d99fc8f8f8872aeae4972d5ff8c9cc5f71392bc18519175d675f9b19ea9bb8ddfd25b167ecab62f50c05cb11af53dd717a9

data/README.md

@@ -1,5 +1,6 @@
-# Policial
+# Policial :cop:
 
+[![Gem Version](https://badge.fury.io/rb/policial.svg)](http://badge.fury.io/rb/policial)
 [![Build Status](https://travis-ci.org/volmer/policial.svg)](https://travis-ci.org/volmer/policial)
 
 *Policial* is a gem that investigates pull requests and accuses style guide
@@ -27,52 +28,57 @@ Or install it yourself as:
 
 ## Usage
 
-First, you need to set your GitHub credentials. For more information on
-this, please check [Octokit README](https://github.com/octokit/octokit.rb).
+1. You might need to instantiate an Octokit client with your GitHub
+  credentials. For more information on this please check the
+  [Octokit README](https://github.com/octokit/octokit.rb).
 
-```ruby
-Octokit.configure do |c|
-  c.access_tokein = 'mygithubtoken666'
-end
-```
+  ```ruby
+  Policial.octokit = Octokit::Client.new(access_token: 'mygithubtoken666')
+  ```
+  Ignore this step if you want Policial to use the global Octokit configuration.
 
-You start with a pull request which Policial will run an investigation
-against. You can setup a pull request manually:
 
-```ruby
-pull_request = Policial::PullRequest.new(
-  repo: 'volmer/my_repo',
-  number: 3,
-  head_sha: 'headsha'
-)
-```
+2. Let's investigate! Start with a pull request which Policial will run an
+  investigation against. You can setup a pull request manually:
 
-Or you can extract a pull request from a
-[GitHub `pull_request` webhook](https://developer.github.com/webhooks):
+  ```ruby
+  pull_request = Policial::PullRequest.new(
+    repo: 'volmer/my_repo',
+    number: 3,
+    head_sha: 'headsha'
+  )
+  ```
 
-```ruby
-event = Policial::PullRequestEvent.new(webhook_payload)
-pull_request = event.pull_request
-```
+  Or you can extract a pull request from a
+  [GitHub `pull_request` webhook](https://developer.github.com/webhooks):
 
-Now you can start an investigation:
+  ```ruby
+  event = Policial::PullRequestEvent.new(webhook_payload)
+  pull_request = event.pull_request
+  ```
 
-```ruby
-investigation = Policial::Investigation.new(pull_request)
+3. Now you can run the investigation:
 
-# Let's investigate this pull request...
-investigation.run
+  ```ruby
+  investigation = Policial::Investigation.new(pull_request)
 
-# Want to know the violations found?
-investigation.violations
+  # Let's investigate this pull request...
+  investigation.run
 
-# Hurry, post comments about those violations on the pull request!
-investigation.accuse
-```
+  # Want to know the violations found?
+  investigation.violations
+  ```
+
+4. Hurry, post comments about those violations on the pull request!
+  ```ruby
+  investigation.accuse
+  ```
+  The result are comments like this on each line that contains violations:
+  ![image](https://cloud.githubusercontent.com/assets/301187/5545861/d5c3da76-8afe-11e4-8c15-341b01f3b820.png)
 
 ## Contributing
 
-1. Fork it ( https://github.com/volmer/policial/fork )
+1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/policial.rb

@@ -4,6 +4,7 @@ require 'policial/accusation_policy'
 require 'policial/commenter'
 require 'policial/commit'
 require 'policial/commit_file'
+require 'policial/octokit_client'
 require 'policial/investigation'
 require 'policial/line'
 require 'policial/patch'
@@ -22,7 +23,7 @@ require 'policial/violation'
 # so you can configure GitHub credentials, enable/disable style guides
 # and more.
 module Policial
-  STYLE_GUIDES = [Policial::StyleGuides::Ruby]
+  extend OctokitClient
 
-  Octokit.auto_paginate = true
+  STYLE_GUIDES = [Policial::StyleGuides::Ruby]
 end

data/lib/policial/commenter.rb

@@ -6,7 +6,7 @@ module Policial
     end
 
     def comment_violation(violation)
-      Octokit.create_pull_request_comment(
+      Policial.octokit.create_pull_request_comment(
         @pull_request.repo,
         @pull_request.number,
         comment_body(violation),

data/lib/policial/commit.rb

@@ -9,7 +9,7 @@ module Policial
     end
 
     def file_content(filename)
-      contents = Octokit.contents(@repo, path: filename, ref: @sha)
+      contents = Policial.octokit.contents(@repo, path: filename, ref: @sha)
 
       if contents && contents.content
         Base64.decode64(contents.content).force_encoding('UTF-8')

data/lib/policial/octokit_client.rb

@@ -0,0 +1,10 @@
+module Policial
+  # Private: wraps accessors for the inner Octokit client.
+  module OctokitClient
+    attr_writer :octokit
+
+    def octokit
+      @octokit || Octokit
+    end
+  end
+end

data/lib/policial/pull_request.rb

@@ -15,7 +15,9 @@ module Policial
     end
 
     def files
-      @files ||= Octokit.pull_request_files(@repo, @number).map do |file|
+      @files ||= Policial.octokit.pull_request_files(
+        @repo, @number
+      ).map do |file|
         build_commit_file(file)
       end
     end
@@ -32,7 +34,7 @@ module Policial
 
     def fetch_comments
       paginate do |page|
-        Octokit.pull_request_comments(
+        Policial.octokit.pull_request_comments(
           @repo,
           @number,
           page: page

data/lib/policial/version.rb

@@ -1,4 +1,4 @@
 # Public: The gem version.
 module Policial
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: policial
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Volmer Soares
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-21 00:00:00.000000000 Z
+date: 2014-12-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: octokit
@@ -55,6 +55,7 @@ files:
 - lib/policial/commit_file.rb
 - lib/policial/investigation.rb
 - lib/policial/line.rb
+- lib/policial/octokit_client.rb
 - lib/policial/patch.rb
 - lib/policial/pull_request.rb
 - lib/policial/pull_request_event.rb