linterbot 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dde45db3e73e3ec689bc1ef9aad6df01df8c763e
+  data.tar.gz: aa351f4a7146f00b5cb26c32dc3b9287fd0ba888
+SHA512:
+  metadata.gz: c022b7291ea41e832744c4980a1f920b2b4bd6b4dbdba4c203794e469bb636cb963354f0f61007d8ccf478c1d2c5ca6d793a0fb2d3496139bf4012dc955a0b07
+  data.tar.gz: 7a271ee4ef5a10dbfa63882b45b24b6fceaed72792ae3157293512fa34a0837e9b8dedffd348a3b24899e79795e5eda85d693b2f6b23492b1051ba49f2524db0

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+.linterbot.yml

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.3.0

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in linterbot.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Guido Marucci Blas
+
+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,49 @@
+# 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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'linterbot'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install linterbot
+
+## Usage
+
+Locally
+
+```
+swiftlint --reporter json | linterbot REPOSITORY PULL_REQUEST_NUMBER
+```
+
+In TravisCI
+
+```
+swiftlint --reporter json | linterbot $TRAVIS_REPO_SLUG $TRAVIS_PULL_REQUEST
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/guidomb/linterbot.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "linterbot"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/linterbot

@@ -0,0 +1,51 @@
+#!/usr/bin/env ruby
+
+if Gem::Specification::find_all_by_name('bundler').any?
+  require 'bundler/setup'
+else
+  require 'rubygems'
+  gem 'linterbot'
+end
+
+require 'commander/import'
+require 'linterbot'
+
+PROGRAM_NAME = 'linterbot'
+DEFAULT_DRY_RUN = false
+
+program :name, PROGRAM_NAME
+program :version, Linterbot::VERSION
+program :description, Linterbot::DESCRIPTION
+default_command :run
+
+def error(message, command)
+  STDERR.puts "Error: #{message}"
+  STDERR.puts "Run 'linterbot help #{command}' for more information."
+  exit 1
+end
+
+command :run do |c|
+  c.syntax = "#{PROGRAM_NAME} run <repository> <pull_request_number> [options]"
+  c.description = 'Analyzes a GitHub pull request for linter violations.'
+  c.option '-p', '--project-base-path PROJECT_BASE_PATH', String, "Sets the project's base path. Default '#{Linterbot::RunnerConfiguration::DEFAULT_PROJECT_BASE_PATH}'."
+  c.option '-c', '--config-file-path', "Sets the config file path. Default '#{Linterbot::RunnerConfiguration::DEFAULT_CONFIG_FILE_PATH}'"
+  c.option '-x', '--dry-run', "Executes bot without modifing GitHub's pull request, Default '#{DEFAULT_DRY_RUN}'"
+  c.option '-f', '--linter-report-file-path LINTER_REPORT_FILE_PATH', String, "Sets the linter report to be used. Default stdin."
+  c.action do |args, options|
+    options.default :'dry-run' => DEFAULT_DRY_RUN
+    repository, pull_request_number = *args.take(2)
+
+    error("You must provide the name of the repository.", "run") unless repository
+    error("You must provide the pull request number.", "run") unless pull_request_number
+
+    begin
+      configuration = Linterbot::RunnerConfiguration.configuration!(options)
+      runner = Linterbot::Runner.new(configuration)
+      runner.run(repository, pull_request_number)
+    rescue Linterbot::RunnerConfiguration::MissingAttribute => exception
+      STDERR.puts "Missing configuration attribute '#{exception.attribute_name}'"
+      STDERR.puts "#{exception.fix_description}"
+      exit 1
+    end
+  end
+end

data/lib/linterbot/comment.rb

@@ -0,0 +1,28 @@
+require 'forwardable'
+
+module Linterbot
+
+  class Comment
+    extend Forwardable
+
+    attr_accessor :sha
+    attr_accessor :patch_line_number
+
+    def_delegator :@hint, :reason, :message
+    def_delegators :@hint,
+      :severity,
+      :file
+
+    def initialize(sha:, hint:, patch_line_number:)
+      @sha = sha
+      @hint = hint
+      @patch_line_number = patch_line_number
+    end
+
+    private
+
+      attr_accessor :hint
+
+  end
+
+end

data/lib/linterbot/comment_generator.rb

@@ -0,0 +1,73 @@
+module Linterbot
+
+  class CommentGenerator
+
+    attr_accessor :filename
+    attr_accessor :commit
+    attr_accessor :pull_request_file_patch
+
+    def initialize(filename, commit, pull_request_file_patch)
+      @filename = filename
+      @commit = commit
+      @pull_request_file_patch = Patch.new(pull_request_file_patch)
+    end
+
+    def generate_comments(hints)
+      hints.map { |hint| generate_comment_for_hint(hint) }
+        .select { |comment| comment != nil }
+    end
+
+    def generate_comment_for_hint(hint)
+      if new_file?
+        generate_comment_for_new_file_and_hint(hint)
+      elsif modified_file? && included_in_file_patch?(hint)
+        generate_comment_for_modified_file_and_hint(hint)
+      end
+    end
+
+    def file
+      @file ||= find_file
+    end
+
+    private
+
+      def find_file
+        file_index = commit.files.find_index { |file| file.filename == filename }
+        commit.files[file_index]
+      end
+
+      def new_file?
+        file.staus == "added"
+      end
+
+      def modified_file?
+        file.status == "modified"
+      end
+
+      def file_patch
+        Patch.new(file.patch)
+      end
+
+      def included_in_file_patch?(hint)
+        file_patch.included_in_patch?(hint)
+      end
+
+      def pull_request_file_patch_line_number(hint)
+        pull_request_file_patch
+          .additions_ranges_for_hint(hint)
+          .map { |diff_range, line_number|  line_number + (hint.line - diff_range.first) + 1 }
+          .first
+      end
+
+      def generate_comment_for_modified_file_and_hint(hint)
+        patch_line_number = pull_request_file_patch_line_number(hint)
+        Comment.new(sha: commit.sha, patch_line_number: patch_line_number, hint: hint)
+      end
+
+      def generate_comment_for_new_file_and_hint(hint)
+        Comment.new(sha: commit.sha, patch_line_number: hint.line, hint: hint)
+      end
+
+  end
+
+end

data/lib/linterbot/commit_approver.rb

@@ -0,0 +1,43 @@
+module Linterbot
+
+  class CommitApprover
+
+    attr_accessor :github_client
+
+    def initialize(github_client)
+      @github_client = github_client
+    end
+
+    def approve(repository, sha)
+      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)
+    end
+
+    def pending(repository, sha)
+      github_client.create_status(repository, sha, "pending", context: context)
+    end
+
+    def error(repository, sha)
+      github_client.create_status(repository, sha, "error", context: context)
+    end
+
+    private
+
+      def context
+        "linterbot"
+      end
+
+      def approve_description
+        "The pull request passed the linter validations!"
+      end
+
+      def reject_description
+        "There are linter violations that must be fixed!"
+      end
+
+  end
+
+end

data/lib/linterbot/description.rb

@@ -0,0 +1,3 @@
+module Linterbot
+  DESCRIPTION = "A bot that parses swiftlint output and analyzes a GitHub pull request."
+end

data/lib/linterbot/github_pull_request_commenter.rb

@@ -0,0 +1,65 @@
+require 'ostruct'
+
+module Linterbot
+
+  class GitHubPullRequestCommenter
+
+    attr_accessor :repository
+    attr_accessor :pull_request_number
+    attr_accessor :github_client
+
+    def initialize(repository, pull_request_number, github_client)
+      @repository = repository
+      @pull_request_number = pull_request_number
+      @github_client = github_client
+    end
+
+    def publish_comment(comment)
+      message = "#{comment.severity.upcase} - #{comment.message}\n"
+      if comment_exist?(message)
+        puts "Comment was not published because it already exists: #{message}"
+      else
+        create_pull_request_comment(message, comment.sha, comment.file, comment.patch_line_number)
+      end
+    end
+
+    def publish_summary(summary)
+      github_client.add_comment(repository, pull_request_number, summary)
+    end
+
+    private
+
+      def create_pull_request_comment(message, sha, file, patch_line_number)
+        args = [
+          repository,
+          pull_request_number,
+          message,
+          sha,
+          file,
+          patch_line_number
+        ]
+        github_client.create_pull_request_comment(*args)
+      end
+
+      def comment_exist?(message)
+        existing_comments.find { |comment| comment.body == message && comment.user.id == bot_github_id }
+      end
+
+      def existing_comments
+        @existing_comments ||= fetch_existing_comments
+      end
+
+      def fetch_existing_comments
+        github_client.pull_request_comments(repository, pull_request_number).map do |comment|
+          user = OpenStruct.new(comment[:user].to_h)
+          OpenStruct.new(comment.to_h.merge(:user => user))
+        end
+      end
+
+      def bot_github_id
+        @bot_github_id ||= github_client.user[:id]
+      end
+
+  end
+
+end

data/lib/linterbot/linter_report.rb

@@ -0,0 +1,47 @@
+require 'ostruct'
+require 'json'
+
+module Linterbot
+
+  class LinterReport
+
+    attr_accessor :report_file
+
+    def initialize(report_file)
+      @report_file = report_file
+    end
+
+    def linter_report
+      @linter_report ||= JSON.parse(report_file_content)
+    end
+
+    def hints_by_file(base_path)
+      hints_for_base_path(base_path).reduce(Hash.new) do |result, hint|
+        hints_for_file = result[hint.file] ||= []
+        hints_for_file << hint
+        result
+      end
+    end
+
+    private
+
+      def hints_for_base_path(base_path)
+        base_path = File.expand_path(base_path)
+        base_path = base_path + "/" unless base_path.end_with?("/")
+        hints = linter_report.map do |hint|
+          hint = hint.merge("file_full_path" => hint["file"], "file" => hint["file"].sub(base_path, ""))
+          OpenStruct.new(hint)
+        end
+      end
+
+      def report_file_content
+        if report_file.kind_of?(IO)
+          report_file.read
+        else
+          File.read(report_file)
+        end
+      end
+
+  end
+
+end

data/lib/linterbot/patch.rb

@@ -0,0 +1,43 @@
+module Linterbot
+
+  class Patch
+
+    MODIFIED_FILE_DIFF_REGEXP = /^@@ -\d+,\d+ \+(\d+),(\d+) @@.*$/
+
+    attr_accessor :patch_content
+
+    def initialize(patch_content)
+      @patch_content = patch_content
+    end
+
+    def chunks_headers
+      @chunks_headers ||= parse_chunks_headers
+    end
+
+    def additions_ranges
+      chunks_headers.map do |diff_header, line_number|
+        match = diff_header.match(MODIFIED_FILE_DIFF_REGEXP)
+        [match[1].to_i...match[2].to_i, line_number]
+      end
+    end
+
+    def additions_ranges_for_hint(hint)
+      additions_ranges.select { |diff_range, line_number| diff_range.include?(hint.line) }
+    end
+
+    def included_in_patch?(hint)
+      additions_ranges_for_hint(hint).count > 0
+    end
+
+    private
+
+      def parse_chunks_headers
+        patch_content
+          .split("\n")
+          .each_with_index
+          .select { |line, line_number| line.start_with?("@@")  }
+      end
+
+  end
+
+end

data/lib/linterbot/pull_request.rb

@@ -0,0 +1,87 @@
+module Linterbot
+
+  class PullRequest
+
+    class AddedModifiedFiles
+
+      def initialize(files)
+        files_key_values = files.select { |file| file.status == "modified" || file.status == "added" }
+          .map { |file| [file.filename, file]}
+          .flatten
+        @files_hash = Hash[*files_key_values]
+      end
+
+      def include?(filename)
+        files_hash.include?(filename)
+      end
+
+      def [](filename)
+        files_hash[filename]
+      end
+
+      private
+
+        attr_accessor :files_hash
+
+    end
+
+    attr_accessor :github_client
+    attr_accessor :repository
+    attr_accessor :pull_request_number
+
+    def initialize(repository, pull_request_number, github_client)
+      @github_client = github_client
+      @repository = repository
+      @pull_request_number = pull_request_number
+    end
+
+    def added_and_modified_files
+      @added_and_modified_files ||= AddedModifiedFiles.new(files)
+    end
+
+    def files
+      @files ||= fetch_pull_request_files
+    end
+
+    def commits
+      @commits ||= fetch_pull_request_commits
+    end
+
+    def commits_for_file(filename)
+      commits.select { |commit| commit.files.map(&:filename).include?(filename) }
+    end
+
+    def file_for_filename(filename)
+      files.select { |file| file.filename == filename }
+        .first
+    end
+
+    def patch_for_file(filename)
+      file = file_for_filename(filename)
+      return file.patch if file
+    end
+
+    def newest_commit
+      commits.first
+    end
+
+    private
+
+      def fetch_pull_request_files
+        github_client.pull_request_files(repository, pull_request_number)
+          .map { |file| OpenStruct.new(file.to_h) }
+      end
+
+      def fetch_pull_request_commits
+        github_client.pull_request_commits(repository, pull_request_number)
+          .reverse
+          .map do |commit|
+            full_commit = github_client.commit(repository, commit.sha).to_h
+            full_commit[:files].map! { |file| OpenStruct.new(file.to_h) }
+            OpenStruct.new(full_commit)
+          end
+      end
+
+  end
+
+end

data/lib/linterbot/pull_request_analysis_result.rb

@@ -0,0 +1,45 @@
+module Linterbot
+
+  class PullRequestAnalysisResult
+
+    attr_accessor :comments
+
+    def initialize(comments)
+      @comments = comments
+    end
+
+    def approved?
+      comments.empty?
+    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}"
+    end
+
+    def serious_violations?
+      serious_violations.count > 0
+    end
+
+    private
+
+      def violations_with_severity(severity)
+        comments.select { |violation| violation.severity == severity }
+      end
+
+      def serious_violations
+        @serious_violations ||= violations_with_severity("Serious")
+      end
+
+      def warning_violations
+        @warning_violations ||= violations_with_severity("Warning")
+      end
+
+  end
+
+end

data/lib/linterbot/pull_request_analyzer.rb

@@ -0,0 +1,46 @@
+module Linterbot
+
+  class PullRequestAnalyzer
+
+    attr_accessor :pull_request
+    attr_accessor :linter_report
+
+    def initialize(linter_report, pull_request)
+      @pull_request = pull_request
+      @linter_report = linter_report
+    end
+
+    def analyze(base_path)
+      comments = hints_in_pull_request(base_path)
+        .each_pair
+        .reduce([]) do |comments, (filename, hints)|
+          comments + generate_comments(filename, hints)
+        end
+      PullRequestAnalysisResult.new(comments)
+    end
+
+    private
+
+      def hints_in_pull_request(base_path)
+        linter_report.hints_by_file(base_path)
+          .select { |filename, hints| analyze_file?(filename) }
+      end
+
+      def analyze_file?(filename)
+        added_and_modified_files.include?(filename)
+      end
+
+      def added_and_modified_files
+        pull_request.added_and_modified_files
+      end
+
+      def generate_comments(filename, hints)
+        pull_request_file_patch = pull_request.patch_for_file(filename)
+        pull_request.commits_for_file(filename)
+          .map { |commit| CommentGenerator.new(filename, commit, pull_request_file_patch).generate_comments(hints) }
+          .flatten
+      end
+
+  end
+
+end

data/lib/linterbot/result_handler.rb

@@ -0,0 +1,38 @@
+module Linterbot
+
+  class ResultHandler
+
+    attr_accessor :pull_request
+    attr_accessor :github_client
+    attr_accessor :commenter
+    attr_accessor :approver
+
+    def initialize(pull_request, commenter, approver)
+      @pull_request = pull_request
+      @commenter = commenter
+      @approver = approver
+    end
+
+    def handle(result)
+      result.comments.each { |comment| commenter.publish_comment(comment) }
+      commenter.publish_summary(result.summary)
+      if result.serious_violations?
+        reject_pull_request
+      else
+        approve_pull_request
+      end
+    end
+
+    private
+
+      def approve_pull_request
+        approver.approve(pull_request.repository, pull_request.newest_commit.sha)
+      end
+
+      def reject_pull_request
+        approver.reject(pull_request.repository, pull_request.newest_commit.sha)
+      end
+
+  end
+
+end

data/lib/linterbot/runner.rb

@@ -0,0 +1,72 @@
+require 'forwardable'
+
+module Linterbot
+
+  class Runner
+    extend Forwardable
+
+    def_delegators :@configuration,
+      :project_base_path,
+      :github_client,
+      :linter_report_file,
+      :commenter_class,
+      :approver_class
+
+    def initialize(configuration)
+      @configuration = configuration
+    end
+
+    def run(repository, pull_request_number)
+      pull_request = new_pull_request(repository, pull_request_number)
+      mark_pull_request_status_as_pending(pull_request)
+      analyze(pull_request)
+    end
+
+    private
+
+      def linter_report
+        @linter_report ||= LinterReport.new(linter_report_file)
+      end
+
+      def analyze(pull_request)
+        analyzer = new_pull_request_analyzer(pull_request)
+        handler = new_result_handler(pull_request)
+        result = analyzer.analyze(project_base_path)
+        handler.handle(result)
+      rescue Exception => exception
+        mark_pull_request_status_as_error(pull_request)
+        raise exception
+      end
+
+      def new_pull_request(repository, pull_request_number)
+        PullRequest.new(repository, pull_request_number, github_client)
+      end
+
+      def new_commenter(pull_request)
+        commenter_class.new(pull_request.repository, pull_request.pull_request_number, github_client)
+      end
+
+      def new_pull_request_analyzer(pull_request)
+        PullRequestAnalyzer.new(linter_report, pull_request)
+      end
+
+      def new_result_handler(pull_request)
+        commenter = new_commenter(pull_request)
+        ResultHandler.new(pull_request, commenter, approver)
+      end
+
+      def approver
+        @approver ||= approver_class.new(github_client)
+      end
+
+      def mark_pull_request_status_as_pending(pull_request)
+        approver.pending(pull_request.repository, pull_request.newest_commit.sha)
+      end
+
+      def mark_pull_request_status_as_error(pull_request)
+        approver.error(pull_request.repository, pull_request.newest_commit.sha)
+      end
+
+  end
+
+end

data/lib/linterbot/runner_configuration.rb

@@ -0,0 +1,93 @@
+require 'octokit'
+require 'yaml'
+require 'ostruct'
+require 'forwardable'
+
+module Linterbot
+
+  class RunnerConfiguration
+    extend Forwardable
+
+    class MissingAttribute < Exception
+
+      attr_accessor :attribute_name
+      attr_accessor :fix_description
+
+      def initialize(attribute_name, fix_description)
+        super("Missing attribute #{attribute_name}")
+        @attribute_name = attribute_name
+        @fix_description = fix_description
+      end
+
+    end
+
+    DEFAULT_PROJECT_BASE_PATH = './'
+    DEFAULT_CONFIG_FILE_PATH = './.linterbot.yml'
+
+    attr_accessor :github_client
+    attr_accessor :commenter_class
+    attr_accessor :approver_class
+    attr_accessor :project_base_path
+    attr_accessor :linter_report_file
+
+    class << self
+
+      def missing_github_access_token
+        fix_description = "You must either define the enviromental variable 'GITHUB_ACCESS_TOKEN " +
+          "or the attribute 'github_access_token' in the configuration file.'"
+        MissingAttribute.new("GitHub access token", fix_description)
+      end
+
+      def load_config_file(config_file_path)
+        if File.exist?(config_file_path)
+          config = YAML.load(File.read(config_file_path))
+          Hash[config.each.map { |key, value| [key.to_sym, value] }]
+        else
+          {}
+        end
+      end
+
+      def default_configuration
+        {
+          project_base_path: File.expand_path(DEFAULT_PROJECT_BASE_PATH),
+          linter_report_file: STDIN,
+          commenter_class: GitHubPullRequestCommenter,
+          approver_class: CommitApprover
+        }
+      end
+
+      def configuration!(options)
+        config_file_path = options.config_file_path || File.expand_path(DEFAULT_CONFIG_FILE_PATH)
+        loaded_config = load_config_file(config_file_path)
+        base_config = default_configuration.merge(loaded_config)
+
+        github_access_token = ENV["GITHUB_ACCESS_TOKEN"] || base_config[:github_access_token]
+        raise missing_github_access_token unless github_access_token
+        github_client = Octokit::Client.new(access_token: github_access_token)
+
+        configuration = new(github_client, base_config)
+        configuration.project_base_path = options.project_base_path if options.project_base_path
+        configuration.linter_report_file = options.linter_report_file_path if options.linter_report_file_path
+
+        if options.dry_run
+          configuration.commenter_class = TTYPullRequestCommenter
+          configuration.approver_class = TTYApprover
+        end
+
+        configuration
+      end
+
+    end
+
+    def initialize(github_client, options)
+      @github_client = github_client
+      @options = options
+      @commenter_class = options[:commenter_class]
+      @approver_class = options[:approver_class]
+      @project_base_path = options[:project_base_path]
+      @linter_report_file = options[:linter_report_file]
+    end
+
+  end
+
+end

data/lib/linterbot/tty_approver.rb

@@ -0,0 +1,34 @@
+module Linterbot
+
+  class TTYApprover
+
+    def initialize(github_client)
+    end
+
+    def approve(repository, sha)
+      puts approve_description
+    end
+
+    def reject(repository, sha)
+      puts reject_description
+    end
+
+    def pending(repository, sha)
+    end
+
+    def error(repository, sha)
+    end
+
+    private
+
+      def approve_description
+        "The pull request passed the linter validations!"
+      end
+
+      def reject_description
+        "There are linter violations that must be fixed!"
+      end
+
+  end
+
+end

data/lib/linterbot/tty_pull_request_commenter.rb

@@ -0,0 +1,26 @@
+module Linterbot
+
+  class TTYPullRequestCommenter
+
+    attr_accessor :repository
+    attr_accessor :pull_request_number
+
+    def initialize(repository, pull_request_number, github_client)
+      @repository = repository
+      @pull_request_number = pull_request_number
+    end
+
+    def publish_comment(comment)
+      puts "#{repository}##{pull_request_number}"
+      puts "#{comment.sha} - #{comment.file}"
+      puts "#{comment.severity} - #{comment.message}"
+      puts ""
+    end
+
+    def publish_summary(summary)
+      puts summary
+    end
+
+  end
+
+end

data/lib/linterbot/version.rb

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

data/lib/linterbot.rb

@@ -0,0 +1,20 @@
+require "linterbot/comment_generator"
+require "linterbot/comment"
+require "linterbot/commit_approver"
+require "linterbot/description"
+require "linterbot/github_pull_request_commenter"
+require "linterbot/linter_report"
+require "linterbot/patch"
+require "linterbot/pull_request_analyzer"
+require "linterbot/pull_request_analysis_result"
+require "linterbot/pull_request"
+require "linterbot/result_handler"
+require "linterbot/runner_configuration"
+require "linterbot/runner"
+require "linterbot/tty_approver"
+require "linterbot/tty_pull_request_commenter"
+require "linterbot/version"
+
+module Linterbot
+
+end

data/linterbot.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'linterbot/version'
+require 'linterbot/description'
+
+Gem::Specification.new do |spec|
+  spec.name          = "linterbot"
+  spec.version       = Linterbot::VERSION
+  spec.authors       = ["Guido Marucci Blas"]
+  spec.email         = ["guidomb@gmail.com"]
+
+  spec.summary       = Linterbot::DESCRIPTION
+  spec.description   = %q{
+    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.
+  }
+  spec.homepage      = "https://github.com/guidomb/linterbot"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry-byebug", "~> 3.3.0"
+
+  spec.add_dependency "octokit", "~> 4.2.0"
+  spec.add_dependency "commander", "~> 4.3.8"
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: linterbot
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Guido Marucci Blas
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: commander
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.3.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.3.8
+description: "\n    A bot that parses swiftlint output and analyzes a GitHub pull
+  request.\n    Then for each linter violation it will make comment in the pull request
+  diff on the\n    line where the violation was made.\n  "
+email:
+- guidomb@gmail.com
+executables:
+- linterbot
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/linterbot
+- lib/linterbot.rb
+- lib/linterbot/comment.rb
+- lib/linterbot/comment_generator.rb
+- lib/linterbot/commit_approver.rb
+- lib/linterbot/description.rb
+- lib/linterbot/github_pull_request_commenter.rb
+- lib/linterbot/linter_report.rb
+- lib/linterbot/patch.rb
+- lib/linterbot/pull_request.rb
+- lib/linterbot/pull_request_analysis_result.rb
+- lib/linterbot/pull_request_analyzer.rb
+- lib/linterbot/result_handler.rb
+- lib/linterbot/runner.rb
+- lib/linterbot/runner_configuration.rb
+- lib/linterbot/tty_approver.rb
+- lib/linterbot/tty_pull_request_commenter.rb
+- lib/linterbot/version.rb
+- linterbot.gemspec
+homepage: https://github.com/guidomb/linterbot
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A bot that parses swiftlint output and analyzes a GitHub pull request.
+test_files: []