policial 0.0.1

checksums.yaml

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Volmer Soares
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,79 @@
+# 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
+violations. It is based on thoughtbot's
+[Hound project](https://github.com/thoughtbot/hound).
+Currently it only investigates ruby code. You can setup your ruby code style
+rules by defining a `.rubocop.yml` file in you repo. Please see
+[RuboCop's README](https://github.com/bbatsov/rubocop).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'policial'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install policial
+
+## Usage
+
+First, you need to set your GitHub credentials. For more information on
+this, please check [Octokit README](https://github.com/octokit/octokit.rb).
+
+```ruby
+Octokit.configure do |c|
+  c.access_tokein = 'mygithubtoken666'
+end
+```
+
+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'
+)
+```
+
+Or you can extract a pull request from a
+[GitHub `pull_request` webhook](https://developer.github.com/webhooks):
+
+```ruby
+event = Policial::PullRequestEvent.new(webhook_payload)
+pull_request = event.pull_request
+```
+
+Now you can start an investigation:
+
+```ruby
+investigation = Policial::Investigation.new(pull_request)
+
+# Let's investigate this pull request...
+investigation.run
+
+# Want to know the violations found?
+investigation.violations
+
+# Hurry, post comments about those violations on the pull request!
+investigation.accuse
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/volmer/policial/fork )
+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`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+RSpec::Core::RakeTask.new(:spec)
+
+task default: [:rubocop, :spec]

data/lib/policial.rb

@@ -0,0 +1,28 @@
+require 'octokit'
+
+require 'policial/accusation_policy'
+require 'policial/commenter'
+require 'policial/commit'
+require 'policial/commit_file'
+require 'policial/investigation'
+require 'policial/line'
+require 'policial/patch'
+require 'policial/pull_request'
+require 'policial/pull_request_event'
+require 'policial/repo_config'
+require 'policial/style_checker'
+require 'policial/style_guides/base'
+require 'policial/style_guides/ruby'
+require 'policial/style_guides/unsupported'
+require 'policial/unchanged_line'
+require 'policial/version'
+require 'policial/violation'
+
+# Public: The global gem module. It exposes some module attribute accessors
+# so you can configure GitHub credentials, enable/disable style guides
+# and more.
+module Policial
+  STYLE_GUIDES = [Policial::StyleGuides::Ruby]
+
+  Octokit.auto_paginate = true
+end

data/lib/policial/accusation_policy.rb

@@ -0,0 +1,34 @@
+module Policial
+  # Public: Checks if a given pull request should be investigated or not.
+  class AccusationPolicy
+    def initialize(pull_request)
+      @pull_request = pull_request
+    end
+
+    def allowed_for?(violation)
+      unreported_violation_messages(violation).any?
+    end
+
+    private
+
+    def unreported_violation_messages(violation)
+      violation.messages - existing_violation_messages(violation)
+    end
+
+    def existing_violation_messages(violation)
+      previous_comments_on_line(violation).map(&:body)
+        .flat_map { |body| body.split('<br>') }
+    end
+
+    def previous_comments_on_line(violation)
+      existing_comments.select do |comment|
+        comment.path == violation.filename &&
+          comment.original_position == violation.patch_position
+      end
+    end
+
+    def existing_comments
+      @existing_comments ||= @pull_request.comments
+    end
+  end
+end

data/lib/policial/commenter.rb

@@ -0,0 +1,25 @@
+module Policial
+  # Public: Comment violations on pull request.
+  class Commenter
+    def initialize(pull_request)
+      @pull_request = pull_request
+    end
+
+    def comment_violation(violation)
+      Octokit.create_pull_request_comment(
+        @pull_request.repo,
+        @pull_request.number,
+        comment_body(violation),
+        @pull_request.head_commit.sha,
+        violation.filename,
+        violation.line_number
+      )
+    end
+
+    private
+
+    def comment_body(violation)
+      violation.messages.join('<br/>')
+    end
+  end
+end

data/lib/policial/commit.rb

@@ -0,0 +1,23 @@
+module Policial
+  # Public: A Commit in a GitHub repo.
+  class Commit
+    attr_reader :repo, :sha
+
+    def initialize(repo, sha)
+      @repo = repo
+      @sha  = sha
+    end
+
+    def file_content(filename)
+      contents = Octokit.contents(@repo, path: filename, ref: @sha)
+
+      if contents && contents.content
+        Base64.decode64(contents.content).force_encoding('UTF-8')
+      else
+        ''
+      end
+    rescue Octokit::NotFound
+      ''
+    end
+  end
+end

data/lib/policial/commit_file.rb

@@ -0,0 +1,40 @@
+module Policial
+  # Public: A file in a commit.
+  class CommitFile
+    attr_reader :commit
+
+    def initialize(file, commit)
+      @file   = file
+      @commit = commit
+    end
+
+    def filename
+      @file.filename
+    end
+
+    def content
+      @content ||= begin
+        @commit.file_content(filename) unless removed?
+      end
+    end
+
+    def removed?
+      @file.status == 'removed'
+    end
+
+    def line_at(line_number)
+      changed_lines.detect { |line| line.number == line_number } ||
+        UnchangedLine.new
+    end
+
+    private
+
+    def changed_lines
+      @changed_lines ||= patch.changed_lines
+    end
+
+    def patch
+      Patch.new(@file.patch)
+    end
+  end
+end

data/lib/policial/investigation.rb

@@ -0,0 +1,35 @@
+module Policial
+  # Public: Starting with unparsed data coming from a pull request event,
+  # it checks all changes introduced looking for style guide violations. It
+  # also accuse all present violations through comments on all relevant lines
+  # in the pull request.
+  class Investigation
+    attr_accessor :violations, :pull_request
+
+    def initialize(pull_request)
+      @pull_request = pull_request
+    end
+
+    def run
+      @violations ||= StyleChecker.new(@pull_request).violations
+    end
+
+    def accuse
+      return if @violations.blank?
+
+      commenter = Commenter.new(@pull_request)
+
+      @violations.each do |violation|
+        if accusation_policy.allowed_for?(violation)
+          commenter.comment_violation(violation)
+        end
+      end
+    end
+
+    private
+
+    def accusation_policy
+      @accusation_policy ||= AccusationPolicy.new(@pull_request)
+    end
+  end
+end

data/lib/policial/line.rb

@@ -0,0 +1,16 @@
+module Policial
+  # Public: a changed line in a commit file.
+  class Line
+    attr_reader :number, :patch_position
+
+    def initialize(number, content, patch_position)
+      @number         = number
+      @content        = content
+      @patch_position = patch_position
+    end
+
+    def changed?
+      true
+    end
+  end
+end

data/lib/policial/patch.rb

@@ -0,0 +1,35 @@
+module Policial
+  # Public: a chunk of changed code in a commit file.
+  class Patch
+    RANGE_INFORMATION_LINE = /^@@ .+\+(?<line_number>\d+),/
+    MODIFIED_LINE = /^\+(?!\+|\+)/
+    NOT_REMOVED_LINE = /^[^-]/
+
+    def initialize(body)
+      @body = body || ''
+    end
+
+    def changed_lines
+      line_number = 0
+
+      @body.lines.each_with_index.with_object([]) do |(line, patch_pos), lines|
+        line_number =
+          parse_line(line, line_number, patch_pos, lines) || line_number
+      end
+    end
+
+    private
+
+    def parse_line(line_content, line_number, patch_position, lines)
+      case line_content
+      when RANGE_INFORMATION_LINE
+        Regexp.last_match[:line_number].to_i
+      when MODIFIED_LINE
+        lines << Line.new(line_number, line_content, patch_position)
+        line_number + 1
+      when NOT_REMOVED_LINE
+        line_number + 1
+      end
+    end
+  end
+end

data/lib/policial/pull_request.rb

@@ -0,0 +1,60 @@
+module Policial
+  # Public: A GibHub Pull Request.
+  class PullRequest
+    attr_reader :repo, :number, :user
+
+    def initialize(repo:, number:, head_sha:, user: nil)
+      @repo     = repo
+      @number   = number
+      @head_sha = head_sha
+      @user     = user
+    end
+
+    def comments
+      @comments ||= fetch_comments
+    end
+
+    def files
+      @files ||= Octokit.pull_request_files(@repo, @number).map do |file|
+        build_commit_file(file)
+      end
+    end
+
+    def head_commit
+      @head_commit ||= Commit.new(@repo, @head_sha)
+    end
+
+    private
+
+    def build_commit_file(file)
+      CommitFile.new(file, head_commit)
+    end
+
+    def fetch_comments
+      paginate do |page|
+        Octokit.pull_request_comments(
+          @repo,
+          @number,
+          page: page
+        )
+      end
+    end
+
+    private
+
+    def paginate
+      page, results, all_pages_fetched = 1, [], false
+
+      until all_pages_fetched
+        if (page_results = yield(page)).empty?
+          all_pages_fetched = true
+        else
+          results += page_results
+          page += 1
+        end
+      end
+
+      results
+    end
+  end
+end

data/lib/policial/pull_request_event.rb

@@ -0,0 +1,29 @@
+require 'json'
+
+module Policial
+  # Public: Parses a pull request event payload.
+  class PullRequestEvent
+    attr_reader :payload
+
+    def initialize(payload)
+      @payload = payload
+    end
+
+    def pull_request
+      @pull_request ||= PullRequest.new(
+        repo: @payload['repository']['full_name'],
+        number: @payload['number'],
+        head_sha: @payload['pull_request']['head']['sha'],
+        user: @payload['pull_request']['user']['login']
+      )
+    rescue NoMethodError
+      nil
+    end
+
+    def should_investigate?
+      !pull_request.nil? && (
+        @payload['action'] == 'opened' || @payload['action'] == 'synchronize'
+      )
+    end
+  end
+end

data/lib/policial/repo_config.rb

@@ -0,0 +1,36 @@
+module Policial
+  # Public: Load and parse config files from GitHub repo.
+  class RepoConfig
+    def initialize(commit)
+      @commit = commit
+    end
+
+    def enabled_for?(style_guide_class)
+      Policial::STYLE_GUIDES.include?(style_guide_class)
+    end
+
+    def for(style_guide_class)
+      config_file = style_guide_class.config_file
+
+      if config_file
+        load_file(config_file)
+      else
+        {}
+      end
+    end
+
+    private
+
+    def load_file(file)
+      config_file_content = @commit.file_content(file)
+
+      parse_yaml(config_file_content) || {}
+    end
+
+    def parse_yaml(content)
+      YAML.load(content)
+    rescue Psych::SyntaxError
+      {}
+    end
+  end
+end

data/lib/policial/style_checker.rb

@@ -0,0 +1,48 @@
+module Policial
+  # Public: Filters files to reviewable subset, builds style guide based on file
+  # extension and delegates to style guide for line violations.
+  class StyleChecker
+    def initialize(pull_request)
+      @pull_request = pull_request
+      @style_guides = {}
+    end
+
+    def violations
+      @violations ||= violations_in_checked_files.select(&:on_changed_line?)
+    end
+
+    private
+
+    attr_reader :pull_request, :style_guides
+
+    def violations_in_checked_files
+      files_to_check.flat_map do |file|
+        style_guide(file.filename).violations_in_file(file)
+      end
+    end
+
+    def files_to_check
+      pull_request.files.reject(&:removed?).select do |file|
+        style_guide(file.filename).enabled?
+      end
+    end
+
+    def style_guide(filename)
+      style_guide_class = style_guide_class(filename)
+      style_guides[style_guide_class] ||= style_guide_class.new(config)
+    end
+
+    def style_guide_class(filename)
+      case filename
+      when /.+\.rb\z/
+        StyleGuides::Ruby
+      else
+        StyleGuides::Unsupported
+      end
+    end
+
+    def config
+      @config ||= RepoConfig.new(pull_request.head_commit)
+    end
+  end
+end

data/lib/policial/style_guides/base.rb

@@ -0,0 +1,18 @@
+module Policial
+  module StyleGuides
+    # Public: Base to contain common style guide logic.
+    class Base
+      def initialize(repo_config)
+        @repo_config = repo_config
+      end
+
+      def enabled?
+        @repo_config.enabled_for?(self.class)
+      end
+
+      def violations_in_file(_file)
+        fail NotImplementedError, "must implement ##{__method__}"
+      end
+    end
+  end
+end

data/lib/policial/style_guides/ruby.rb

@@ -0,0 +1,67 @@
+require 'rubocop'
+
+module Policial
+  module StyleGuides
+    # Public: Determine Ruby style guide violations per-line.
+    class Ruby < Base
+      class << self
+        attr_writer :config_file
+
+        def config_file
+          @config_file || RuboCop::ConfigLoader::DOTFILE
+        end
+      end
+
+      def violations_in_file(file)
+        if config.file_to_exclude?(file.filename)
+          []
+        else
+          offenses = team.inspect_file(parsed_source(file))
+          build_violations(offenses, file)
+        end
+      end
+
+      private
+
+      def team
+        RuboCop::Cop::Team.new(RuboCop::Cop::Cop.all, config, rubocop_options)
+      end
+
+      def parsed_source(file)
+        RuboCop::ProcessedSource.new(file.content, file.filename)
+      end
+
+      def config
+        @config ||= RuboCop::ConfigLoader.merge_with_default(custom_config, '')
+      end
+
+      def custom_config
+        custom = @repo_config.for(self.class)
+
+        if custom.is_a?(Hash)
+          RuboCop::Config.new(custom, '').tap do |config|
+            config.add_missing_namespaces
+            config.make_excludes_absolute
+          end
+        else
+          RuboCop::Config.new
+        end
+      end
+
+      def rubocop_options
+        { debug: true } if config['ShowCopNames']
+      end
+
+      def build_violations(offenses, file)
+        offenses.each_with_object({}) do |offense, violations|
+          if violations[offense.line]
+            violations[offense.line].add_messages([offense.message])
+          else
+            violations[offense.line] =
+              Violation.new(file, offense.line, offense.message)
+          end
+        end.values
+      end
+    end
+  end
+end

data/lib/policial/style_guides/unsupported.rb

@@ -0,0 +1,10 @@
+module Policial
+  module StyleGuides
+    # Public: Returns empty set of violations.
+    class Unsupported < Base
+      def violations_in_file(_)
+        []
+      end
+    end
+  end
+end

data/lib/policial/unchanged_line.rb

@@ -0,0 +1,15 @@
+module Policial
+  # Public: An unchanged line in a commit file.
+  class UnchangedLine
+    def initialize(*)
+    end
+
+    def patch_position
+      -1
+    end
+
+    def changed?
+      false
+    end
+  end
+end

data/lib/policial/version.rb

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

data/lib/policial/violation.rb

@@ -0,0 +1,30 @@
+module Policial
+  # Public: Hold file, line, and violation message values. Built by style
+  # guides.
+  class Violation
+    attr_reader :line_number, :filename
+
+    def initialize(file, line_number, message)
+      @filename    = file.filename
+      @line        = file.line_at(line_number)
+      @line_number = line_number
+      @messages    = [message]
+    end
+
+    def add_messages(messages)
+      @messages += messages
+    end
+
+    def messages
+      @messages.uniq
+    end
+
+    def patch_position
+      @line.patch_position
+    end
+
+    def on_changed_line?
+      @line.changed?
+    end
+  end
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: policial
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Volmer Soares
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+description: Review pull requests for style guide violations.
+email:
+- volmerius@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/policial.rb
+- lib/policial/accusation_policy.rb
+- lib/policial/commenter.rb
+- lib/policial/commit.rb
+- lib/policial/commit_file.rb
+- lib/policial/investigation.rb
+- lib/policial/line.rb
+- lib/policial/patch.rb
+- lib/policial/pull_request.rb
+- lib/policial/pull_request_event.rb
+- lib/policial/repo_config.rb
+- lib/policial/style_checker.rb
+- lib/policial/style_guides/base.rb
+- lib/policial/style_guides/ruby.rb
+- lib/policial/style_guides/unsupported.rb
+- lib/policial/unchanged_line.rb
+- lib/policial/version.rb
+- lib/policial/violation.rb
+homepage: https://github.com/volmer/policial
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Review pull requests for style guide violations
+test_files: []