github_commenter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8881b422640642f18b254be0de4128bd861375ee
+  data.tar.gz: 86a3c02b88f7f7037375fb37d298acc2c1b4e05b
+SHA512:
+  metadata.gz: d19812132ce7a5f4a82b2976af0f41299ac681669711fcc2ecfc551bbeaf656b35ba17da2f99ea90991eb06e702a04791034e92e9175a296183f646fdd0ed765
+  data.tar.gz: 440454140f7e42cbf40aecf746bc7aab3f87ba50107c6ccd3e24a6498d02de475d71d78874fba8500160f9fa8e25485e79e891f20efb177198c65faa681ea574

data/.gitignore

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, 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, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at okita.kunio@dena.jp. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 okita-kunio
+
+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,41 @@
+# GithubCommenter
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/github_commenter`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'github_commenter'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install github_commenter
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/[USERNAME]/github_commenter. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## 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,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "github_commenter"
+
+# 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/github_commenter

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "github_commenter/cli"
+
+::GithubCommenter::CLI.start

data/github_commenter.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+Gem::Specification.new do |spec|
+  spec.name          = "github_commenter"
+  spec.version       = File.read(File.expand_path("../VERSION", __FILE__)).chomp
+  spec.authors       = ["okitan"]
+  spec.email         = ["okitakunio@gmail.com"]
+
+  spec.summary       = "CLI to comment github"
+  spec.description   = "CLI to comment github PR/commit"
+  spec.homepage      = "https://github.com/okitan/github_commenter"
+  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_dependency "addressable"
+  spec.add_dependency "git"
+  spec.add_dependency "git_diff_parser"
+  spec.add_dependency "ltsv"
+  spec.add_dependency "octokit"
+  spec.add_dependency "thor"
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/github_commenter.rb

@@ -0,0 +1,3 @@
+module GithubCommenter
+  # Your code goes here...
+end

data/lib/github_commenter/cli.rb

@@ -0,0 +1,178 @@
+require "github_commenter"
+
+require "thor"
+
+require "addressable/template"
+require "git"
+require "git_diff_parser"
+require "octokit"
+
+module GithubCommenter
+  class CLI < ::Thor
+    class << self
+      def github_pr_options
+        option :from_env, enum: %w[ circleci ], description: "complete things from ENV variables of CI. override github,repo,pr,after,until"
+
+        # github things
+        option :github, description: "github API entry point (default: https://api.github.com/v3)"
+        option :repo,   description: "respoitory of github e.g. okitan/github_commenter"
+        option :pr, type: :numeric, description: "number of PR"
+
+        option :github_access_token, required: true, default: ENV["GITHUB_ACCESS_TOKEN"]
+
+        # comments
+        option :after, description: "post comment when commits of inserting this line after this hash exist"
+        option :until, description: "post comment when commits of inserting this line exists"
+      end
+    end
+
+    desc "pr", "comment to pr"
+    github_pr_options
+
+    option :input_format, default: "ltsv", enum: %w[ ltsv ], description: "when stdin comes, it will be parsed according to this format"
+
+    option :message, description: "when no stdin comes, we use this option as pr comment message"
+    option :file,    description: "when no stdin comes, we use this option as target file of pr comment"
+    option :line,    type: :numeric, description: "when no stdin comes, we use this option as line number in target file of pr comment (Note: this is not line in diff of pr)"
+
+    option :debug, type: :boolean, descriptin: "if true, do not post pr comment"
+    def pr
+      @options, comments = parse_options
+
+      post_pr_comments(filter_comments(comments, after: @options["after"], _until: @options["before"]))
+    end
+
+    protected
+    def post_pr_comments(comments)
+      base = pr_info.base.sha
+      head = ::Git::Log.new(::Git.open("."), 1).last.sha
+
+      diff = GitDiffParser.parse(`git diff #{base}`)
+
+      comments.each do |comment|
+        patch_position = find_patch_position_of_comment(diff, comment)
+
+        if @options["debug"]
+          warn "PR comment to #{@options["repo"]}/pulls/#{@options["pr"]}@#{head}##{comment[:file]}:#{patch_position} => #{comment[:message]}"
+        else
+          github_client.create_pull_request_comment(@options["repo"], @options["pr"], comment[:message], head, comment[:file], patch_position)
+        end
+      end
+    end
+
+    def github_client
+      @github_client ||= begin
+        Octokit.configure {|config| config.api_endpoint = @options["github"] }
+        Octokit::Client.new(access_token: @options["github_access_token"])
+      end
+    end
+
+    def pr_info
+      @pr_info ||= begin
+        github_client.pull_request(@options["repo"], @options["pr"])
+      end
+    end
+
+    def filter_comments(comments, after: nil, _until: nil)
+      after ||= pr_info.base.sha
+
+      # XXX: commandline injection risk
+      diff = GitDiffParser.parse(::Git::Diff.new(::Git.open("."), after, _until).patch)
+
+      comments.select do |comment|
+        if comment[:file]
+          find_patch_position_of_comment(diff, comment)
+        else # pr comment
+          false # TODO: post to pr
+        end
+      end
+    end
+
+    def find_patch_position_of_comment(diff, comment)
+      diff_of_file = diff.find {|f| f.file == comment[:file] }
+
+      if diff_of_file
+        line = diff_of_file.changed_lines.find {|line| line.number == comment[:line].to_i }
+
+        return line.patch_position if line
+      end
+
+      nil
+    end
+
+    def parse_options
+      comments = if stdin?
+        parse_comments($stdin.read)
+      else
+        if options[:message] && options[:file] && options[:line]
+          [ { message: options[:message], file: options[:file], line: options[:line] } ]
+        else
+          raise ::Thor::RequiredArgumentMissingError, "no comments found. gives stdin or use --message option"
+        end
+      end
+
+      options = complete_options(self.options)
+
+      return [ options, comments ]
+    end
+
+    def parse_comments(string)
+      case options[:input_format]
+      when "ltsv"
+        require "ltsv"
+
+        LTSV.parse(string).map do |line|
+          line[:line] = line[:line].to_i if line[:line]
+          line
+        end
+      else
+        raise "unknown input format: #{options[:input_format]}"
+      end
+    end
+
+    def complete_options(options)
+      complete = case options[:from_env]
+      when "circleci"
+        completed_params_of_circleci(options)
+      else
+        {}
+      end
+
+      options.merge(complete)
+    end
+
+    def completed_params_of_circleci(options)
+      if pr = ENV["CI_PULL_REQUEST"]
+        pr_num = pr.split("/").last.to_i
+
+        template = Addressable::Template.new("https://{host}/{organization}/{repository}/compare/{after}...{until}")
+
+        if params = template.extract(ENV["CIRCLE_COMPARE_URL"])
+          github = if params["host"] == "github.com"
+            "https://api.github.com/v3"
+          else
+            "https://#{params["host"]}/api/v3" # I don't know this is correct
+          end
+
+          return {
+            "github" => github,
+            "repo"   => [ params["organization"], params["repository"] ].join("/"),
+            "pr"     => pr_num,
+            "after"  => params["after"],
+            "until"  => params["until"]
+          }
+        else
+          warn `env`
+          raise "really?"
+        end
+      end
+
+      {}
+    end
+
+    def stdin?
+      # http://www.ownway.info/Ruby/idiom/judge_stdin
+      File.pipe?($stdin) || File.select([$stdin], [], [], 0)
+    end
+  end
+end

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification
+name: github_commenter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- okitan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: addressable
+  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
+  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: ltsv
+  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: 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: thor
+  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.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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'
+description: CLI to comment github PR/commit
+email:
+- okitakunio@gmail.com
+executables:
+- github_commenter
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- bin/console
+- bin/setup
+- exe/github_commenter
+- github_commenter.gemspec
+- lib/github_commenter.rb
+- lib/github_commenter/cli.rb
+homepage: https://github.com/okitan/github_commenter
+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: CLI to comment github
+test_files: []