ghrt 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8472f8b21106014d61a409b355493e0d0c053fce56e6a099f8b461a2f9acaec8
+  data.tar.gz: 8222ce6c112c2ed4faa574ab6ae9e6f3b044613cc78eeb0c3731f3809ea0bb4d
+SHA512:
+  metadata.gz: f78178d097c7bf826b766f37c71ddf1950361fa9d346b2c45e53d6180349d96e8c7a31b19ec6d25d93e8449fcbc0b14e40dfc4aace92a549dc8baa1416ba718d
+  data.tar.gz: 3c9f8460aec4e9662b4bbf927bcf6aecd10d8ff80bba32ae9af85a3105e1414f4ce4a98e331c2a00a603a250f4c8a27c989bf45039ab51eedea1d54fedca9360

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+Gemfile.lock
+/ghrt-*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,18 @@
+AllCops:
+  TargetRubyVersion: 2.5
+
+Documentation:
+  Enabled: false
+
+# Following appears to be problematic with the slack-ruby-bot Gem
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*_spec.rb'
+    - 'lib/tasks/**/*.rake'
+    - 'db/schema.rb'

data/.ruby-version

@@ -0,0 +1 @@
+2.5.3

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 1.16.6

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in ghrt.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Alex Leaver
+
+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,39 @@
+# GHRT (GitHub Review Tool)
+
+A simple Gem for for extracting your comments made against a PR and using this as a form of checklist
+to identify your original comments and whether they have been addressed.
+
+Not my finest piece of work, but a quick conversion of a Ruby script to a Gem so that it could be shared with
+other developers.
+
+## Installation
+
+### From RubyGems.org
+
+```gem install ghrt```
+
+### From Source
+
+Clone this repository and run `bundle exec rake install`.
+
+## Usage
+
+* Ensure `GITHUB_USERNAME` is set with your GitHub username
+* Ensure `GITHUB_TOKEN` is set with your GitHub token
+* Run with `ghrt -p <pr_number> --repo <org/repo> > comments.html` 
+  * e.g. `ghrt -p 1234 --repo amleaver/ghrt > comments.html`
+  * Full list of argument can be returned with `ghrt -h`
+
+## Development
+
+* Run `bin/setup` to install dependencies
+* Run `rake spec` to run the tests (not implemented yet) 
+* Run `bin/console` for an interactive prompt that will allow you to experiment
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/amleaver/ghrt.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'ghrt'
+
+# 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(__FILE__)

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/ghrt

@@ -0,0 +1,42 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Allows the script to be called directly without installing the gem
+begin
+  require 'ghrt'
+rescue LoadError
+  require 'bundler/setup'
+  require 'ghrt'
+end
+
+require 'optparse'
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = 'Usage: ghrt [options]'
+
+  opts.on('-v', '--verbose', 'Run verbosely') do |v|
+    options[:verbose] = v
+  end
+
+  opts.on('-r', '--repo <org/repo>', 'Github repostiory') do |repo|
+    options[:repo] = repo
+  end
+
+  opts.on('-p', '--pull-request <number>', 'Pull request number') do |number|
+    options[:pr] = number
+  end
+
+  opts.on('-s', '--since <yyyy-mm-dd>', 'Only return comments since ISO date') do |date|
+    options[:since] = date
+  end
+
+  opts.separator ''
+  opts.separator "Version #{Ghrt::VERSION}"
+end.parse!
+
+raise '--repo and --pull-request parameters must be provided' unless options[:repo] && options[:pr]
+
+puts options if options[:verbose]
+
+puts Ghrt::ReviewerComments.to_html(options[:repo], options[:pr], options[:since], options[:verbose])

data/ghrt.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ghrt/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ghrt'
+  spec.version       = Ghrt::VERSION
+  spec.authors       = ['Alex Leaver']
+  spec.email         = ['amleaver@gmail.com']
+
+  spec.summary       = 'GitHub Review Tools'
+  spec.description   = 'Provides tools for assisting with GitHub reviews'
+  spec.homepage      = 'https://github.com/amleaver/ghrt'
+  spec.license       = 'MIT'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'kramdown', '~> 2.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.63.1'
+end

data/lib/ghrt.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'ghrt/version'
+require 'ghrt/github'
+require 'ghrt/reviewer_comments'
+
+module Ghrt
+  # Your code goes here...
+end

data/lib/ghrt/github.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require 'uri'
+require 'net/http'
+require 'json'
+require 'base64'
+require 'date'
+
+module Ghrt
+  class Github
+    def initialize(repo, verbose)
+      @repo = repo
+      @username = ENV['GITHUB_USERNAME']
+      @token = ENV['GITHUB_TOKEN']
+      raise 'GITHUB_USERNAME and GITHUB_TOKEN environment variables must be set' unless @username && @token
+
+      @verbose = verbose
+    end
+
+    def review_comments(pull_request, since)
+      response = []
+      page = 1
+
+      loop do
+        paged_response = query_github("/pulls/#{pull_request}/comments?since=#{since}&per_page=100&page=#{page}")
+        break if paged_response.empty?
+
+        response.concat(paged_response)
+        page += 1
+      end
+
+      response.select do |comment|
+        comment['user']['login'] == @username &&
+        DateTime.parse(comment['created_at']) >= DateTime.parse(since) if since
+      end
+    end
+
+    private
+
+    def query_github(path)
+      url = URI("https://api.github.com/repos/#{@repo}#{path}")
+      puts url if @verbose
+
+      http = Net::HTTP.new(url.host, url.port)
+      http.use_ssl = true
+
+      request = Net::HTTP::Get.new(url)
+      request['Authorization'] = auth_header
+
+      parse_response(http.request(request))
+    end
+
+    def parse_response(response)
+      puts response.code if @verbose
+      raise "Unexpected API response status #{response.code}" unless response.code == '200'
+
+      JSON.parse(response.read_body)
+    end
+
+    def auth_header
+      auth_header = "Basic #{Base64.urlsafe_encode64("#{@username}:#{@token}")}"
+      puts auth_header if @verbose
+      auth_header
+    end
+
+    def validate_envars
+      return unless ENV['GITHUB_USERNAME'] && ENV['GITHUB_TOKEN']
+
+      raise 'GITHUB_USERNAME and GITHUB_TOKEN environment variables have not been set'
+    end
+  end
+end

data/lib/ghrt/reviewer_comments.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'kramdown'
+
+module Ghrt
+  class ReviewerComments
+    # rubocop:disable Metrics/MethodLength
+    def self.to_html(repo, pull_request, since, verbose)
+      user_comments = Github.new(repo, verbose).review_comments(pull_request, since)
+
+      # TODO: this really should be re-written using ERB or somesuch
+      html = <<~HTML
+        <html>
+          <head>
+            <title>PR #{pull_request}</title>
+            <link rel='stylesheet' href='https://stackpath.bootstrapcdn.com/bootswatch/4.2.1/darkly/bootstrap.min.css'/>
+            <script src="https://rawgit.com/google/code-prettify/master/loader/run_prettify.js?autoload=true&amp;skin=doxy&amp;lang=css"></script>
+          </head>
+          <body>
+            <div class="container">
+            <h2>#{user_comments.count} Comments#{since ? "Since #{since}" : nil}</h2>
+      HTML
+
+      user_comments.each_with_index do |comment, index|
+        html += <<~HTML
+          <div class="row" ondblclick="this.classList.add('collapse')">
+            <div class="col-xl-12 mb-2">
+              <a target="_blank" href='#{comment['html_url']}'><h3>##{index + 1} - #{comment['path']}:#{comment['original_position']}</h3></a>
+              <div class="pl-3">
+                <pre class="prettyprint"><code>#{normalise_diff_hunk(comment['diff_hunk'])}</code></pre>
+                <div class="text-muted" style="font-size: 1.1em">#{Kramdown::Document.new(comment['body']).to_html}</div>
+              </div>
+            </div>
+          </div>
+        HTML
+      end
+
+      html += <<~HTML
+            </div>
+          </body>
+        </html>
+      HTML
+    end
+    # rubocop:enable Metrics/MethodLength
+
+    # Make hunks 6 lines long and remove headers
+    def self.normalise_diff_hunk(hunk)
+      return hunk.lines.to_a[1..-1].join if hunk.lines.count <= 6
+
+      hunk.lines.to_a[(hunk.lines.count - 6)..-1].join
+    end
+  end
+end

data/lib/ghrt/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Ghrt
+  VERSION = '0.4.0'
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: ghrt
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- Alex Leaver
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-04-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.63.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.63.1
+description: Provides tools for assisting with GitHub reviews
+email:
+- amleaver@gmail.com
+executables:
+- ghrt
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/ghrt
+- ghrt.gemspec
+- lib/ghrt.rb
+- lib/ghrt/github.rb
+- lib/ghrt/reviewer_comments.rb
+- lib/ghrt/version.rb
+homepage: https://github.com/amleaver/ghrt
+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.7.6
+signing_key: 
+specification_version: 4
+summary: GitHub Review Tools
+test_files: []