saddler-reporter-github 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1dc735b2cef637c5d5a467a40b8bf593451220f9
-  data.tar.gz: ef5f818d8cce267bfd9daad9835774c4301324b0
+  metadata.gz: 879b2b1b02b0f258dc52c8d8707b0ea05f12f69e
+  data.tar.gz: 4061ab75257db71d06d0d6ca4b866d7bb04a03cc
 SHA512:
-  metadata.gz: 0fae38fc76fb4b589153a7cc78852b2a145f559adbf6aaf5103362ec48f137a505eff4b0362d167cff55694265a92d26ff5ed3a8ef2a234e280c9c7e23d02082
-  data.tar.gz: 13c3bdb196b3aa9d8c2afc3230478ed027fa56aac1f3276c455bea638602390db19d240c45d7a1630f6a50bdd438461bc371eddfeb31b4848c282037bdabb0bc
+  metadata.gz: e63cd96035d3cb1796e15a1afb769bc870c3762a74dcc8377b5ac1d41cda24465912835b46b074083e5d881aa7d212cc4aae343f2b7db52e51b17ff04e641a68
+  data.tar.gz: 014f24df85b94364edf83afdc9b8c45ffc90306496f950cb76cfec5194b3b7c6a26f765aa8cb27a0855ae87e86ca5f6fea8dff91b7f3f49f5ddf7afc354e5dec

data/.conventional-changelog.context.js

@@ -0,0 +1,17 @@
+'use strict';
+var execSync = require('child_process').execSync;
+var URI = require('urijs');
+
+var gemspec = JSON.parse(execSync('bundle exec parse-gemspec-cli saddler-reporter-github.gemspec'));
+var homepageUrl = gemspec.homepage;
+var url = new URI(homepageUrl);
+var host = url.protocol() + '://' + url.authority();
+var owner = url.pathname().split('/')[1];
+var repository = url.pathname().split('/')[2];
+
+module.exports = {
+  version: gemspec.version,
+  host: host,
+  owner: owner,
+  repository: repository
+};

data/.rubocop.yml

@@ -12,6 +12,3 @@ Metrics/LineLength:
 Style/FileName:
   Exclude:
     - exe/*
-
-Style/RegexpLiteral:
-  MaxSlashes: 0

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+<a name="0.1.6"></a>
+## [0.1.6](https://github.com/packsaddle/ruby-saddler-reporter-github/compare/v0.1.5...v0.1.6) (2015-10-02)
+
+* Improve document.
+
+
 <a name="0.1.5"></a>
 ## [0.1.5](https://github.com/packsaddle/ruby-saddler-reporter-github/compare/v0.1.4...v0.1.5) (2015-09-21)
 

data/Gemfile

@@ -2,5 +2,9 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in saddler-reporter-github.gemspec
 gemspec
+
 gem 'byebug' if RUBY_VERSION >= '2.0.0'
+gem 'parse_gemspec-cli'
 gem 'pry'
+gem 'rubocop'
+gem 'yard'

data/README.md

@@ -1,7 +1,8 @@
 # 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)
+[![Gem version][gem-image]][gem-url] [![Travis-CI Status][travis-image]][travis-url] [![yard docs][docs-image]][docs-url]
+
+> [Saddler](https://github.com/packsaddle/ruby-saddler) reporter for GitHub.
 
 
 ## Reporters
@@ -9,9 +10,17 @@
 This provides saddler reporters for GitHub.
 
 * PullRequestComment
+    * `--require saddler/reporter/github`
+    * `--reporter Saddler::Reporter::Github::PullRequestComment`
 * PullRequestReviewComment
-* CommitComment(under construction)
-* CommitReviewComment(under construction)
+    * `--require saddler/reporter/github`
+    * `--reporter Saddler::Reporter::Github::PullRequestReviewComment`
+* CommitComment (_under construction_)
+    * `--require saddler/reporter/github`
+    * `--reporter Saddler::Reporter::Github::CommitComment`
+* CommitReviewComment (_under construction_)
+    * `--require saddler/reporter/github`
+    * `--reporter Saddler::Reporter::Github::CommitReviewComment`
 
 
 ## Usage
@@ -22,7 +31,7 @@ $ saddler report \
    --reporter Saddler::Reporter::Github::PullRequestReviewComment
 ```
 
-like this.
+like this. See [Saddler](https://github.com/packsaddle/ruby-saddler).
 
 
 ## Requirement
@@ -45,6 +54,16 @@ $ travis encrypt -r <owner_name>/<repos_name> "GITHUB_ACCESS_TOKEN=<github_token
 [Environment variables - CircleCI](https://circleci.com/docs/environment-variables)
 
 
+## API
+
+*[details][docs-url]*.
+
+
+## Changelog
+
+[CHANGELOG.md](./CHANGELOG.md).
+
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -76,3 +95,17 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 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
+
+
+## License
+
+© [sanemat](http://sane.jp)
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+[travis-url]: https://travis-ci.org/packsaddle/ruby-saddler-reporter-github
+[travis-image]: https://img.shields.io/travis/packsaddle/ruby-saddler-reporter-github/master.svg?style=flat-square&label=build%20%28linux%29
+[gem-url]: https://rubygems.org/gems/saddler-reporter-github
+[gem-image]: http://img.shields.io/gem/v/saddler-reporter-github.svg?style=flat-square
+[docs-url]: http://www.rubydoc.info/gems/saddler-reporter-github
+[docs-image]: https://img.shields.io/badge/yard-docs-blue.svg?style=flat-square

data/Rakefile

@@ -7,3 +7,12 @@ Rake::TestTask.new(:test) do |t|
 end
 
 task default: :test
+
+require 'yard'
+require 'yard/rake/yardoc_task'
+DOC_FILES = ['lib/**/*.rb']
+DOC_OPTIONS = ['--debug', '--verbose']
+YARD::Rake::YardocTask.new(:doc) do |t|
+  t.files = DOC_FILES
+  t.options = DOC_OPTIONS if Rake.application.options.trace
+end

data/bin/setup

@@ -1,7 +1,15 @@
-#!/bin/bash
-set -euo pipefail
-IFS=$'\n\t'
+#!/usr/bin/env ruby
 
-bundle install
-
-# Do any other automated setup that you need to do here
+require 'open3'
+unless ENV['CI']
+  out, err, status = Open3.capture3(*%w(bundle install))
+  $stdout.puts out
+  $stderr.puts err
+  exit status.exitstatus if !status.exitstatus.nil? && status.exitstatus != 0
+end
+unless ENV['CI']
+  out, err, status = Open3.capture3(*%w(npm install))
+  $stdout.puts out
+  $stderr.puts err
+  exit status.exitstatus if !status.exitstatus.nil? && status.exitstatus != 0
+end

data/lib/saddler/reporter/github.rb

@@ -14,6 +14,7 @@ require 'saddler/reporter/github/pull_request_review_comment'
 module Saddler
   module Reporter
     class ArgumentError < StandardError; end
+    # Saddler reporter for GitHub.
     module Github
       class InvalidParameterError < ::Saddler::Reporter::ArgumentError; end
     end

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

@@ -1,22 +1,35 @@
 module Saddler
   module Reporter
     module Github
+      # GitHub client wrapper
       class Client
+        # @param repo [::Saddler::Reporter::Support::Git::Repository] git repository
         def initialize(repo)
           @repo = repo
         end
 
+        # @param sha [String] target commit sha
+        #
+        # @return [Array<Comment>] parse commit comments into Comment
         def commit_comments(sha)
           client.commit_comments(slug, sha).map do |comment|
             Comment.new(sha, comment.body, comment.path, comment.position)
           end
         end
 
+        # @param comment [Comment] posting commit comment
+        #
+        # @return [Sawyer::Resource] Commit comment
+        #
+        # @see ::Octokit::Client::CommitComments.create_commit_comment
         def create_commit_comment(comment)
           client.create_commit_comment(slug, comment.sha, comment.body,
                                        comment.path, nil, comment.position)
         end
 
+        # @param sha [String] target commit sha
+        #
+        # @return [::GitDiffParser::Patches<::GitDiffParser::Patch>] patches
         def commit_patches(sha)
           patches = ::GitDiffParser::Patches[]
           client.commit(slug, sha).files.each do |file|
@@ -25,22 +38,31 @@ module Saddler
           patches
         end
 
+        # @return [Array<Comment>] parse issue comments into Comment
         def issue_comments
           client.issue_comments(slug, pull_id).map do |comment|
-            Comment.new(sha = nil, comment.body, comment.path, comment.position)
+            sha = nil
+            Comment.new(sha, comment.body, comment.path, comment.position)
           end
         end
 
+        # @param comment [Comment] posting issue comment
+        #
+        # @return [Sawyer::Resource] Comment
+        #
+        # @see ::Octokit::Client::Issues.add_comment
         def create_issue_comment(comment)
           client.add_comment(slug, pull_id, comment.body)
         end
 
+        # @return [Array<Comment>] parse pull request comments into Comment
         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
 
+        # @return [::GitDiffParser::Patches<::GitDiffParser::Patch>] patches
         def pull_request_patches
           patches = ::GitDiffParser::Patches[]
           client.pull_request_files(slug, pull_id).each do |file|
@@ -49,11 +71,17 @@ module Saddler
           patches
         end
 
+        # @param comment [Comment] posting pull request comment
+        #
+        # @return [Sawyer::Resource] Hash representing the new comment
+        #
+        # @see ::Octokit::Client::PullRequests.create_pull_request_comment
         def create_pull_request_review_comment(comment)
           client.create_pull_request_comment(slug, pull_id, comment.body,
                                              comment.sha, comment.path, comment.position)
         end
 
+        # @return [Integer, nil] pull request id
         def pull_id
           @pull_id ||= begin
             pull_id = env_pull_id
@@ -66,22 +94,29 @@ module Saddler
           end
         end
 
+        # @return [Array<Sawyer::Resource>] Array of pulls
+        #
+        # @see ::Octokit::Client::PullRequests.pull_requests
         def pull_requests
           @pull_requests ||= client.pull_requests(slug)
         end
 
+        # @return [String, nil] repository's slug
         def slug
           @slug ||= @repo.slug
         end
 
+        # @return [Octokit::Client]
         def client
           @client ||= Octokit::Client.new(access_token: access_token)
         end
 
+        # @return [String, nil] github access token
         def access_token
           ENV['GITHUB_ACCESS_TOKEN']
         end
 
+        # @return [Integer, nil] pull request id from environment variables
         def env_pull_id
           if ENV['PULL_REQUEST_ID']
             ENV['PULL_REQUEST_ID'].to_i

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

@@ -5,7 +5,13 @@ module Saddler
         include ::Saddler::Reporter::Support
         include Helper
 
-        # https://developer.github.com/v3/repos/comments/#create-a-commit-comment
+        # @param messages [String] checkstyle string
+        # @param options [Hash]
+        # @option options [String] sha target commit sha
+        #
+        # @return [void]
+        #
+        # @see 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)
@@ -20,7 +26,10 @@ module Saddler
           # build comment
           body = concat_body(data)
           return if body.empty?
-          comment = Comment.new(sha, body, path = nil, position = nil)
+
+          path = nil
+          position = nil
+          comment = Comment.new(sha, body, path, position)
 
           # compare commit_comments.include?(comment)
           return if commit_comments.include?(comment)

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

@@ -7,7 +7,13 @@ module Saddler
         include ::Saddler::Reporter::Support
         include Helper
 
-        # https://developer.github.com/v3/repos/comments/#create-a-commit-comment
+        # @param messages [String] checkstyle string
+        # @param options [Hash]
+        # @option options [String] sha target commit sha
+        #
+        # @return [void]
+        #
+        # @see 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)

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

@@ -1,7 +1,13 @@
 module Saddler
   module Reporter
     module Github
+      # Helper for saddler-reporter-github
       module Helper
+        # Concatenate parsed errors
+        #
+        # @param data [Object] parsed checkstyle data
+        #
+        # @return [String] concatenated errors. separated with new line.
         def concat_body(data)
           buffer = []
           files = data['checkstyle']['file'] ||= []
@@ -18,6 +24,12 @@ module Saddler
           buffer.join("\n")
         end
 
+        # Build comment objects by parsed errors and patches
+        #
+        # @param data [Object] parsed checkstyle data
+        # @param patches [Patches<Patch>] `git diff`'s patch section
+        #
+        # @return [Array<Comment>] comment objects
         def build_comments_with_patches(data, patches)
           comments = []
           files = data['checkstyle']['file'] ||= []

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

@@ -5,7 +5,12 @@ module Saddler
         include ::Saddler::Reporter::Support
         include Helper
 
-        # https://developer.github.com/v3/issues/comments/#create-a-comment
+        # @param messages [String] checkstyle string
+        # @param _options [Hash]
+        #
+        # @return [void]
+        #
+        # @see 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)
@@ -19,7 +24,11 @@ module Saddler
           # build comment
           body = concat_body(data)
           return if body.empty?
-          comment = Comment.new(sha1 = nil, body, path = nil, position = nil)
+
+          sha = nil
+          path = nil
+          position = nil
+          comment = Comment.new(sha, body, path, position)
 
           # compare pull_request_comments.include?(comment)
           return if pull_request_comments.include?(comment)

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

@@ -5,7 +5,12 @@ module Saddler
         include ::Saddler::Reporter::Support
         include Helper
 
-        # https://developer.github.com/v3/pulls/comments/#create-a-comment
+        # @param messages [String] checkstyle string
+        # @param _options [Hash]
+        #
+        # @return [void]
+        #
+        # @see 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/lib/saddler/reporter/github/version.rb

@@ -1,7 +1,7 @@
 module Saddler
   module Reporter
     module Github
-      VERSION = '0.1.5'
+      VERSION = '0.1.6'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: saddler-reporter-github
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - sanemat
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-09-21 00:00:00.000000000 Z
+date: 2015-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: octokit
@@ -115,6 +115,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".conventional-changelog.context.js"
 - ".gitignore"
 - ".rubocop.yml"
 - CHANGELOG.md
@@ -124,7 +125,6 @@ files:
 - README.md
 - Rakefile
 - bin/console
-- bin/conventional-changelog
 - bin/setup
 - lib/saddler/reporter/github.rb
 - lib/saddler/reporter/github/client.rb
@@ -161,3 +161,4 @@ signing_key:
 specification_version: 4
 summary: Saddler reporter for GitHub.
 test_files: []
+has_rdoc: 

data/bin/conventional-changelog

@@ -1,35 +0,0 @@
-#!/usr/bin/env node
-
-var fs = require('fs');
-var execSync = require('child_process').execSync;
-var conventionalChangelog = require('conventional-changelog');
-var tempfile = require('tempfile');
-var addStream = require('add-stream');
-
-var version = "" + execSync('ruby -e \'require "./lib/saddler/reporter/github/version"; print Saddler::Reporter::Github::VERSION\'');
-
-var options = { preset: 'angular' };
-var templateContext = {
-  version: version,
-  host: 'https://github.com',
-  owner: 'packsaddle',
-  repository: 'ruby-saddler-reporter-github'
-};
-var infile = 'CHANGELOG.md';
-var outfile = 'CHANGELOG.md';
-var changelogStream = conventionalChangelog(options, templateContext)
-  .on('error', function(err) {
-    console.error(err.toString());
-    process.exit(1);
-  });
-
-var tmp = tempfile();
-var readStream = fs.createReadStream(infile);
-
-changelogStream
-  .pipe(addStream(readStream))
-  .pipe(fs.createWriteStream(tmp))
-  .on('finish', function() {
-    fs.createReadStream(tmp)
-      .pipe(fs.createWriteStream(outfile));
-  });