saddler-reporter-github 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5a54f0b00d0a8ccf4dd9bca6b35949d26e0891e5
+  data.tar.gz: 6a866714ea731c76b352c3c78e7bf7ca2fe95a22
+SHA512:
+  metadata.gz: 56cdca0dcff8a4bdff2ffdf8c62199fa44b752ae8de3d73872d8cfe7b1b06977f67fabb473b23f0e77d7a4a1443abcc0008d2417c0baff68c027857c33767c7b
+  data.tar.gz: 44cf9e2690347d8d448f5096b688375fb6f48c251a3a2887fa9564271a9410224fb0727ac8e17cab90954f7b134f390aeebb40036425dd9edfcc221586c9155d

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,17 @@
+AllCops:
+  Exclude:
+    - 'bundle_bin/*'
+    - 'vendor/bundle/**/*'
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 120
+
+Style/FileName:
+  Exclude:
+    - exe/*
+
+Style/RegexpLiteral:
+  MaxSlashes: 0

data/.tachikoma.yml

@@ -0,0 +1 @@
+strategy: 'none'

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+sudo: false
+rvm:
+  - 1.9
+  - 2.0
+  - 2.1
+  - 2.2
+before_install:
+  - gem update bundler
+notifications:
+  email:
+    - ogataken@gmail.com
+branches:
+  only:
+    - master

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in saddler-reporter-github.gemspec
+gemspec
+gem 'byebug' if RUBY_VERSION >= '2.0.0'
+gem 'pry'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 sanemat
+
+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,53 @@
+# Saddler::Reporter::Github
+
+[![Gem Version](http://img.shields.io/gem/v/saddler-reporter-github.svg?style=flat)](http://badge.fury.io/rb/saddler-reporter-github)
+[![Build Status](http://img.shields.io/travis/packsaddle/ruby-saddler-reporter-github/master.svg?style=flat)](https://travis-ci.org/packsaddle/ruby-saddler-reporter-github)
+
+## Reporters
+
+This provides saddler reporters for GitHub.
+
+* CommitComment
+* CommitReviewComment
+* PullRequestComment
+* PullRequestReviewComment
+
+## Usage
+
+```
+$ saddler report \
+   --require saddler/reporter/github \
+   --reporter Saddler::Reporter::Github::PullRequestReviewComment
+```
+
+like this.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'saddler-reporter-github'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install saddler-reporter-github
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/packsaddle/ruby-saddler-reporter-github/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,9 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/**/test*.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'saddler/reporter/github'
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/saddler/reporter/github.rb

@@ -0,0 +1,21 @@
+require 'octokit'
+require 'git_diff_parser'
+require 'saddler/reporter/support'
+require 'saddler/reporter/support/git'
+require 'saddler/reporter/github/version'
+require 'saddler/reporter/github/helper'
+require 'saddler/reporter/github/client'
+require 'saddler/reporter/github/comment'
+require 'saddler/reporter/github/commit_comment'
+require 'saddler/reporter/github/commit_review_comment'
+require 'saddler/reporter/github/pull_request_comment'
+require 'saddler/reporter/github/pull_request_review_comment'
+
+module Saddler
+  module Reporter
+    class ArgumentError < StandardError; end
+    module Github
+      class InvalidParameterError < ::Saddler::Reporter::ArgumentError; end
+    end
+  end
+end

data/lib/saddler/reporter/github/client.rb

@@ -0,0 +1,87 @@
+module Saddler
+  module Reporter
+    module Github
+      class Client
+        def initialize(repo)
+          @repo = repo
+        end
+
+        def commit_comments(sha)
+          client.commit_comments(slug, sha).map do |comment|
+            Comment.new(sha, comment.body, comment.path, comment.position)
+          end
+        end
+
+        def create_commit_comment(comment)
+          client.create_commit_comment(slug, comment.sha, comment.body,
+                                       comment.path, nil, comment.position)
+        end
+
+        def commit_patches(sha)
+          patches = ::GitDiffParser::Patches[]
+          client.commit(slug, sha).files.each do |file|
+            patches << ::GitDiffParser::Patch.new(file.patch, file: file.filename, secure_hash: sha)
+          end
+          patches
+        end
+
+        def issue_comments
+          client.issue_comments(slug, pull_id).map do |comment|
+            Comment.new(sha = nil, comment.body, comment.path, comment.position)
+          end
+        end
+
+        def create_issue_comment(comment)
+          client.add_comment(slug, pull_id, comment.body)
+        end
+
+        def pull_request_review_comments
+          client.pull_request_comments(slug, pull_id).map do |comment|
+            Comment.new(comment.commit_id, comment.body, comment.path, comment.position)
+          end
+        end
+
+        def pull_request_patches
+          patches = ::GitDiffParser::Patches[]
+          client.pull_request_files(slug, pull_id).each do |file|
+            patches << ::GitDiffParser::Patch.new(file.patch, file: file.filename, secure_hash: @repo.head.sha)
+          end
+          patches
+        end
+
+        def create_pull_request_review_comment(comment)
+          client.create_pull_request_comment(slug, pull_id, comment.body,
+                                             comment.sha, comment.path, comment.position)
+        end
+
+        def pull_id
+          @pull_id ||= begin
+            pull_id = ENV['PULL_REQUEST_ID']
+            if pull_id
+              pull_id.to_i
+            elsif @repo.current_branch
+              pull = pull_requests.find { |pr| pr[:head][:ref] == @repo.current_branch }
+              pull[:number].to_i if pull
+            end
+          end
+        end
+
+        def pull_requests
+          @pull_requests ||= client.pull_requests(slug)
+        end
+
+        def slug
+          @slug ||= @repo.slug
+        end
+
+        def client
+          @client ||= Octokit::Client.new(access_token: access_token)
+        end
+
+        def access_token
+          ENV['GITHUB_ACCESS_TOKEN']
+        end
+      end
+    end
+  end
+end

data/lib/saddler/reporter/github/comment.rb

@@ -0,0 +1,13 @@
+module Saddler
+  module Reporter
+    module Github
+      Comment = Struct.new(:sha, :body, :path, :position) do
+        def ==(other)
+          position == other.position &&
+          path == other.path &&
+          body == other.body
+        end
+      end
+    end
+  end
+end

data/lib/saddler/reporter/github/commit_comment.rb

@@ -0,0 +1,33 @@
+module Saddler
+  module Reporter
+    module Github
+      class CommitComment
+        include ::Saddler::Reporter::Support
+        include Helper
+
+        # https://developer.github.com/v3/repos/comments/#create-a-commit-comment
+        def report(messages, options)
+          repo_path = '.'
+          repo = ::Saddler::Reporter::Support::Git::Repository.new(repo_path)
+
+          sha = options['sha'] || repo.head.sha
+          data = parse(messages)
+
+          client = Client.new(repo)
+          # fetch commit_comments
+          commit_comments = client.commit_comments(sha)
+
+          # build comment
+          body = concat_body(data)
+          return if body.empty?
+          comment = Comment.new(sha, body, path = nil, position = nil)
+
+          # compare commit_comments.include?(comment)
+          return if commit_comments.include?(comment)
+          # create commit_comment
+          client.create_commit_comment(comment)
+        end
+      end
+    end
+  end
+end

data/lib/saddler/reporter/github/commit_review_comment.rb

@@ -0,0 +1,37 @@
+require 'pathname'
+
+module Saddler
+  module Reporter
+    module Github
+      class CommitReviewComment
+        include ::Saddler::Reporter::Support
+        include Helper
+
+        # https://developer.github.com/v3/repos/comments/#create-a-commit-comment
+        def report(messages, options)
+          repo_path = '.'
+          repo = ::Saddler::Reporter::Support::Git::Repository.new(repo_path)
+
+          sha = options['sha'] || repo.head.sha
+          data = parse(messages)
+
+          client = Client.new(repo)
+          # fetch commit_comments
+          commit_comments = client.commit_comments(sha)
+
+          patches = client.commit_patches(sha)
+          # build comment
+          comments = build_comments_with_patches(data, patches)
+          return if comments.empty?
+
+          posting_comments = comments - commit_comments
+          return if posting_comments.empty?
+          # create commit_comment
+          posting_comments.each do |posting|
+            client.create_commit_comment(posting)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/saddler/reporter/github/helper.rb

@@ -0,0 +1,48 @@
+module Saddler
+  module Reporter
+    module Github
+      module Helper
+        def concat_body(data)
+          buffer = []
+          files = data['checkstyle']['file'] ||= []
+          files = [files] if files.is_a?(Hash)
+          files.each do |file|
+            errors = file['error'] ||= []
+            errors = [file['error']] if errors.is_a?(Hash)
+            errors.each do |error|
+              severity = error['@severity'] && error['@severity'].upcase
+              message = error['@message']
+              buffer << [severity, message].compact.join(': ')
+            end
+          end
+          buffer.join("\n")
+        end
+
+        def build_comments_with_patches(data, patches)
+          comments = []
+          files = data['checkstyle']['file'] ||= []
+          files = [files] if files.is_a?(Hash)
+          files.each do |file|
+            errors = file['error'] ||= []
+            errors = [file['error']] if errors.is_a?(Hash)
+            file_name = file['@name'] ||= ''
+            patch = patches.find_patch_by_file(file_relative_path_string(file_name))
+            next unless patch
+
+            errors.each do |error|
+              line_no = error['@line'] && error['@line'].to_i
+              next unless patch.changed_line_numbers.include?(line_no)
+
+              severity = error['@severity'] && error['@severity'].upcase
+              message = error['@message']
+              position = patch.find_patch_position_by_line_number(line_no)
+
+              comments << Comment.new(patch.secure_hash, [severity, message].compact.join(': '), patch.file, position)
+            end
+          end
+          comments
+        end
+      end
+    end
+  end
+end

data/lib/saddler/reporter/github/pull_request_comment.rb

@@ -0,0 +1,32 @@
+module Saddler
+  module Reporter
+    module Github
+      class PullRequestComment
+        include ::Saddler::Reporter::Support
+        include Helper
+
+        # https://developer.github.com/v3/issues/comments/#create-a-comment
+        def report(messages, _options)
+          repo_path = '.'
+          repo = ::Saddler::Reporter::Support::Git::Repository.new(repo_path)
+
+          data = parse(messages)
+
+          client = Client.new(repo)
+          # fetch pull_request_comments(issue)
+          pull_request_comments = client.issue_comments
+
+          # build comment
+          body = concat_body(data)
+          return if body.empty?
+          comment = Comment.new(sha1 = nil, body, path = nil, position = nil)
+
+          # compare pull_request_comments.include?(comment)
+          return if pull_request_comments.include?(comment)
+          # create pull_request_comment
+          client.create_issue_comment(comment)
+        end
+      end
+    end
+  end
+end

data/lib/saddler/reporter/github/pull_request_review_comment.rb

@@ -0,0 +1,35 @@
+module Saddler
+  module Reporter
+    module Github
+      class PullRequestReviewComment
+        include ::Saddler::Reporter::Support
+        include Helper
+
+        # https://developer.github.com/v3/pulls/comments/#create-a-comment
+        def report(messages, _options)
+          repo_path = '.'
+          repo = ::Saddler::Reporter::Support::Git::Repository.new(repo_path)
+
+          data = parse(messages)
+          client = Client.new(repo)
+          # fetch pull_request_review_comments
+          pull_request_review_comments = client.pull_request_review_comments
+
+          patches = client.pull_request_patches
+
+          # build comment
+          comments = build_comments_with_patches(data, patches)
+          return if comments.empty?
+
+          posting_comments = comments - pull_request_review_comments
+          return if posting_comments.empty?
+
+          # create pull_request_review_comments
+          posting_comments.each do |posting|
+            client.create_pull_request_review_comment(posting)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/saddler/reporter/github/version.rb

@@ -0,0 +1,7 @@
+module Saddler
+  module Reporter
+    module Github
+      VERSION = '0.1.0'
+    end
+  end
+end

data/saddler-reporter-github.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'saddler/reporter/github/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'saddler-reporter-github'
+  spec.version       = Saddler::Reporter::Github::VERSION
+  spec.authors       = ['sanemat']
+  spec.email         = ['o.gata.ken@gmail.com']
+
+  spec.summary       = 'Saddler reporter for GitHub.'
+  spec.description   = 'Saddler reporter for GitHub.'
+  spec.homepage      = 'https://github.com/packsaddle/ruby-saddler-reporter-github'
+  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_runtime_dependency 'octokit'
+  spec.add_runtime_dependency 'git_diff_parser'
+  spec.add_runtime_dependency 'saddler-reporter-support'
+  spec.add_runtime_dependency 'saddler-reporter-support-git'
+
+  spec.add_development_dependency 'bundler', '~> 1.8'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'test-unit'
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: saddler-reporter-github
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- sanemat
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-02-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: git_diff_parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: saddler-reporter-support
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: saddler-reporter-support-git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !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: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Saddler reporter for GitHub.
+email:
+- o.gata.ken@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".tachikoma.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/saddler/reporter/github.rb
+- lib/saddler/reporter/github/client.rb
+- lib/saddler/reporter/github/comment.rb
+- lib/saddler/reporter/github/commit_comment.rb
+- lib/saddler/reporter/github/commit_review_comment.rb
+- lib/saddler/reporter/github/helper.rb
+- lib/saddler/reporter/github/pull_request_comment.rb
+- lib/saddler/reporter/github/pull_request_review_comment.rb
+- lib/saddler/reporter/github/version.rb
+- saddler-reporter-github.gemspec
+homepage: https://github.com/packsaddle/ruby-saddler-reporter-github
+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: Saddler reporter for GitHub.
+test_files: []