pr_summary 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4976834ede12de72752fa94ebecd0e025f46331b
+  data.tar.gz: 0fa689a6f2903f3dcd34cfbc97a8074dbc9a75a0
+SHA512:
+  metadata.gz: d6fc190d6651c198d0ae0e961d3461f48ee2e2d9737022ff3bdc3d10ba35fee684e4c275d6c10513014429b8233756cd078dfdb06f653a8670f72d2c346d3883
+  data.tar.gz: 829fc1eee17d8b699d6cd8d9be3148d76dba44cebe4cab7d14768b7806dbce1c24b4879f81e339d2d553974e881626b6190e5744bff9237f59b6898f7e6d7f17

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

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 dustin@zeisler.net. 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 pr_summary.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Dustin Zeisler
+
+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,45 @@
+# PrSummary
+
+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/pr_summary`. 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 'pr_summary'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pr_summary
+
+## Usage
+
+```bash
+pr_summary [pull_request_number] [branch] [base]
+```
+
+Create file `{org}_{repo}_#{pull_request_number}.md`
+
+## 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/[USERNAME]/pr_summary. 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,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 "pr_summary"
+
+# 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/pr_summary

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "pr_summary"
+
+PrSummary.call(pull_request_number:  (ENV["PR_NUM"] || ARGV[0]).chomp, branch: (ENV["BRANCH"] || ARGV[1]).chomp, base: (ENV["BASE"] || ARGV[2]).chomp)

data/lib/pr_summary/branch_diff.rb

@@ -0,0 +1,10 @@
+module PrSummary
+  class BranchDiff
+    attr_reader :base, :branch
+
+    def initialize(base:, branch:)
+      @base   = base
+      @branch = branch
+    end
+  end
+end

data/lib/pr_summary/file_diff.rb

@@ -0,0 +1,55 @@
+require "pr_summary/git"
+
+module PrSummary
+  class FileDiff
+    attr_reader :diff, :filename
+
+    def initialize(filename:, diff:)
+      @filename = filename
+      @diff     = diff
+    end
+
+    def insertions
+      file_changes[__method__]
+    end
+
+    def deletions
+      file_changes[__method__]
+    end
+
+    def changes_display
+      str = ""
+      str << "#{insertions}(+)" if insertions
+      str << "#{deletions}(-)" if deletions
+      str
+    end
+
+    def truncated_name
+      if filename.length > MAX_FILE_NAME_LENGTH
+        "..." + filename[(filename.length-(MAX_FILE_NAME_LENGTH-3))..-1]
+      else
+        filename
+      end
+    end
+
+    def md5_file
+      Digest::MD5.new.update(filename).to_s
+    end
+
+    private
+
+    def file_changes
+      @file_changes ||= begin
+        text = PrSummary::Git::Diff.new(diff: diff).shortstat(filename)
+        {
+          insertions: find_number_before(text, "insertion"),
+          deletions:  find_number_before(text, "deletion")
+        }
+      end
+    end
+
+    def find_number_before(text, word)
+      text.scan(/(\d+) #{word}/)[0][0].to_i rescue nil
+    end
+  end
+end

data/lib/pr_summary/git.rb

@@ -0,0 +1,78 @@
+require 'digest'
+require 'tempfile'
+
+module PrSummary
+  module Git
+    class << self
+      def repo
+        `basename \`git rev-parse --show-toplevel\``.chomp
+      end
+
+      def org
+        `git remote get-url origin`.split(":").last.split("/").first.chomp
+      end
+
+      def temp_file(name=('a'..'z').to_a.sample(5), &block)
+        tmp_file = Tempfile.new(name)
+        block.call(tmp_file.path)
+        tmp_file.tap(&:rewind).read.chomp.tap do
+          tmp_file.close
+        end.to_s
+      end
+
+      def call(cmd)
+        temp_file do |path|
+          git_cmd = "git #{cmd} > #{path}"
+          puts git_cmd
+          system(git_cmd)
+        end
+      end
+    end
+
+    class PullRequest
+      attr_reader :repo, :org, :number
+
+      def initialize(org: Git.org, repo: Git.repo, number:)
+        @org    = org
+        @repo   = repo
+        @number = number
+      end
+
+      def url
+        "https://github.com/#{org}/#{repo}/pull/#{number}"
+      end
+
+      def file_url(filename)
+        "#{url}/files#diff-#{md5_filename(filename)}"
+      end
+
+      def key
+        "#{org}_#{repo}_#{number}"
+      end
+
+      private
+
+      def md5_filename(filename)
+        Digest::MD5.new.update(filename).to_s
+      end
+    end
+
+    class Diff
+      def initialize(diff:)
+        @diff = diff
+      end
+
+      def shortstat(filename)
+        Git.call("diff --shortstat #{diff.branch} #{diff.base} -- #{filename}")
+      end
+
+      def name_only
+        Git.call("diff --name-only #{diff.branch} #{diff.base}").split("\n")
+      end
+
+      private
+
+      attr_reader :diff
+    end
+  end
+end

data/lib/pr_summary/version.rb

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

data/lib/pr_summary.rb

@@ -0,0 +1,78 @@
+require "yaml"
+require "json"
+require "pr_summary/file_diff"
+require "pr_summary/git"
+require "pr_summary/branch_diff"
+
+module PrSummary
+  VERSION              = "0.1.0"
+  MAX_FILE_NAME_LENGTH = 84
+
+  class << self
+    def call(pull_request_number:, branch:, base:)
+      pr            = Git::PullRequest.new(number: pull_request_number)
+      diff          = BranchDiff.new(base: base, branch: branch)
+      markdown_text = create_md(diff, pr)
+      save_to_file(markdown_text, pr)
+    end
+
+    def save_to_file(markdown_text, pr)
+      File.open("#{pr.key}.md", "w") { |file| file.write(markdown_text) }
+    end
+
+    def create_md(diff, pr)
+      grouped_files(diff).map do |type, files|
+        files = files.map do |file|
+          link = "[#{file.truncated_name}](#{pr.file_url(file.filename)})"
+          "* **#{file.changes_display}** #{link}"
+        end.join("\n")
+        "## #{type}\n#{files}\n\n"
+      end.join("\n")
+    end
+
+    def grouped_files(diff)
+      grouped               = group_files_by_type(diff)
+      sorted_files_in_group = sort_by_insertion_count(diff, grouped)
+      listed_order.each_with_object({}) do |type, hash|
+        files = sorted_files_in_group[type]
+        next if files.nil?
+        hash[type] = files
+      end
+    end
+
+    def sort_by_insertion_count(diff, grouped)
+      grouped.each do |type, files|
+        grouped[type] = files.map do |file|
+          FileDiff.new(filename: file, diff: diff)
+        end
+        grouped[type] = grouped[type].sort_by { |f| f.insertions || 0 }.reverse
+      end
+      grouped
+    end
+
+    def group_files_by_type(diff)
+      Git::Diff.new(diff: diff).name_only.group_by do |filename|
+        groups.keys.detect do |group|
+          groups[group].any? { |reg| reg =~ filename }
+        end
+      end
+    end
+
+    def listed_order
+      [:code, :spec, :fixtures_and_data, :database, :mocks, :other, :documentation]
+    end
+
+    def groups
+      {
+        database:          [/migrate/, /schema\.rb$/, /structure\.sql$/],
+        fixtures_and_data: [/.\.yml$/, /.\.json$/, /.\.json\.erb$/],
+        spec:              [/._spec\.rb$/, /spec\//],
+        mocks:             [/._mock\.rb$/],
+        code:              [/.\.rb$/],
+        documentation:     [/.\.md$/],
+        other:             [/.*/]
+      }
+    end
+  end
+end
+

data/pr_summary.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pr_summary/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "pr_summary"
+  spec.version       = PrSummary::VERSION
+  spec.authors       = ["Dustin Zeisler"]
+  spec.email         = ["dustin@zeisler.net"]
+
+  spec.summary       = %q{Sumarize a pull request}
+  spec.description   = %q{Sumarize a pull request seperate by types of file and link to with the ability to comment on that file.}
+  spec.homepage      = "https://github.com/zeisler/pr_summary"
+  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.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: pr_summary
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dustin Zeisler
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-22 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !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'
+description: Sumarize a pull request seperate by types of file and link to with the
+  ability to comment on that file.
+email:
+- dustin@zeisler.net
+executables:
+- pr_summary
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/pr_summary
+- lib/pr_summary.rb
+- lib/pr_summary/branch_diff.rb
+- lib/pr_summary/file_diff.rb
+- lib/pr_summary/git.rb
+- lib/pr_summary/version.rb
+- pr_summary.gemspec
+homepage: https://github.com/zeisler/pr_summary
+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.8
+signing_key: 
+specification_version: 4
+summary: Sumarize a pull request
+test_files: []