github_changes 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 91e338d415d8597cc4d26affc9f90edee506b5a8
+  data.tar.gz: f161536c7da8b87c25d208ed3f313b7bf6100f35
+SHA512:
+  metadata.gz: 12ad2188c031f14f1b028d12d02702d0adee8c714d4646240d9bc539ef7eeb89394adff81bfbf7f350d43d8515b5713a61a6e504c4640168501f8ae4f46176e2
+  data.tar.gz: 218d4597fde0c6c4d62ac0c351ff69f188593f9985cce98dc732ddabd9fd96ae5bfc4744fff13fdecd32ee902d60fb6755811cd0221ed107a36aa70f987121bb

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,4 @@
+language: ruby
+rvm:
+  - 2.1.5
+before_install: gem install bundler -v 1.10.6

data/Gemfile

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

data/README.md

@@ -0,0 +1,36 @@
+# ChangelogGenerator
+
+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/changelog_generator`. 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 'changelog_generator'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install changelog_generator
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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]/changelog_generator.
+

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 "changelog_generator"
+
+# 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/changelog_generator.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'changelog_generator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "github_changes"
+  spec.version       = ChangelogGenerator::VERSION
+  spec.authors       = ["Cody Rayment"]
+  spec.email         = ["crayment16@gmail.com"]
+
+  spec.summary       = %q{Generate Release Notes}
+  # spec.description   = %q{TODO: Write a longer description or delete this line.}
+  # spec.homepage      = "https://robotsandpencils.com"
+
+  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 'thor'
+  spec.add_dependency 'github_api'
+  spec.add_dependency 'chronic'
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/exe/github_changes

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby -wU
+
+require 'changelog_generator'
+
+ChangelogGenerator::CLI.start(ARGV)

data/lib/changelog_generator/cli.rb

@@ -0,0 +1,38 @@
+require 'thor'
+$thor_runner = false
+
+module ChangelogGenerator
+  class CLI < Thor
+    desc "hello NAME", "This will greet you"
+    long_desc <<-EOS
+    `hello NAME` will print out a message to the person of your choosing.
+    EOS
+    option :upcase
+    def hello(name)
+      greeting = "Hello, #{name}!"
+      greeting.upcase! if options[:upcase]
+      puts greeting
+    end
+
+    desc "generate", "Generates release notes."
+    long_desc <<-EOS
+    Will generate release notes for the given repository information between
+    the given references (TO defaults to master) by querying github pull requests.
+    EOS
+    method_option :user, :aliases => "-u", :type => :string, :required => true
+    method_option :repo, :aliases => "-r", :type => :string, :required => true
+    method_option :from_ref, :aliases => "-f", :type => :string, :required => true
+    method_option :to_ref, :aliases => "-t", :type => :string, :default => "master"
+    method_option :label_filter, :aliases => "-l", :type => :string
+    def generate()
+      generator = Generator.new(options[:user], options[:repo], options[:from_ref], options[:to_ref], options[:label_filter])
+      puts generator.description
+      begin
+        puts generator.changelog
+      rescue Exception => e
+        STDERR.puts "#{e}"
+        STDERR.puts e.backtrace
+      end
+    end
+  end
+end

data/lib/changelog_generator/generator.rb

@@ -0,0 +1,213 @@
+require 'github_api'
+require 'chronic'
+require 'changelog_generator/pull_request'
+require 'changelog_generator/issue'
+
+module ChangelogGenerator
+  class Generator
+    attr_accessor :user
+    attr_accessor :repo_name
+    attr_accessor :from_ref
+    attr_accessor :to_ref
+    attr_accessor :label_filter
+
+    def initialize(user, repo, from_ref, to_ref, label_filter = nil)
+      self.user = user
+      self.repo_name = repo
+      self.from_ref = from_ref
+      self.to_ref = to_ref || "master"
+      self.label_filter = label_filter
+    end
+
+    def description
+      description = "Changes for #{user}/#{repo_name} from #{from_ref} to #{to_ref}"
+      if label_filter
+        description << " with label '#{label_filter}'"
+      end
+      description
+    end
+
+    def changelog
+      generate_changelog(user, repo_name, from_ref, to_ref, label_filter, nil)
+    end
+
+    private
+
+    def generate_changelog(user, repo, start_ref, end_ref, label_filter = nil, exclude_sha = nil, changelog)
+      start_date, end_date = *date_range_for_references(start_ref, end_ref)
+      # puts "Start: #{start_ref}, End: #{end_ref}"
+      unless start_date && end_date
+        return "Failed to acquire date range from references"
+      end
+      pulls = pull_requests_for_date_range(start_date, end_date)
+      pull_nums = pulls.map { |p| p['number'] }
+
+      if pull_nums.empty?
+        return "No PRs found matching criteria"
+      else
+        # puts "  PRs: #{pull_nums}"
+        # puts
+      end
+
+      if label_filter && !label_filter.empty?
+        # puts "Filtering PRs on label #{label_filter}:"
+        pull_nums = pull_nums.select do |n|
+          issue = github.issues.get user, repo, n
+          label_names = issue.labels.map { |l| l.name }
+          label_names.include?(label_filter)
+        end
+        # puts "  PRs: #{pull_nums}"
+        # puts
+      end
+
+      if pull_nums.empty?
+        return "No PRs found matching criteria"
+      end
+
+      pulls = pull_nums.map { |p| github.pull_requests.get(user, repo, p) }
+      pulls = pulls.map { |p| PullRequest.from_github_pr(p) }
+      # puts JSON.pretty_generate(pulls.first.body.to_hash)
+
+      # puts "Finding connected issues:"
+      pulls.each do |pull|
+        issue_nums = connected_issues_from_pr(pull)
+        github_issues = issue_nums.map { |n| github.issues.get(user, repo, n) }
+        issues = github_issues.map { |i| Issue.from_github_issue(i) }
+        pull.issues = issues.compact
+      end
+
+      commits = pulls.map { |p| p.head_sha[0..7] }
+
+      connected_issue_nums = pulls.map(&:issues).flatten.map(&:number)
+
+      logs = pulls.map { |p| p.changelog_text }
+      logs = logs.reject(&:empty?)
+      
+      string = "```\n"
+      string << logs.join("\n")
+      string << "\n```"
+      string << "\n\n"
+
+      # string << "<https://github.com/#{user}/#{repo}/pulls?q=is%3Apr+#{commits.join("+")}|PRs> | "
+      # string << "<https://github.com/#{user}/#{repo}/issues?q=is%3Aissue+#{connected_issue_nums.join("+")}|Issues> | "
+      # string << "<https://github.com/#{user}/#{repo}/issues?q=#{commits.join("+")}+#{connected_issue_nums.join("+")}|Both>"
+
+      string << "PRs: https://github.com/#{user}/#{repo}/pulls?q=is%3Apr+#{commits.join("+")}\n"
+      string << "Issues: https://github.com/#{user}/#{repo}/issues?q=is%3Aissue+#{connected_issue_nums.join("+")}\n"
+      string << "Both: https://github.com/#{user}/#{repo}/issues?q=#{commits.join("+")}+#{connected_issue_nums.join("+")}\n"
+
+      string << "\n"
+    end
+
+    def github
+      @github ||= Github.new({ oauth_token: ENV['GITHUB_TOKEN'] })
+    end
+
+    def check_github_response
+      begin
+        value = yield
+      rescue Github::Error::Unauthorized => e
+        abort "Error: wrong GitHub token"
+      rescue Github::Error::Forbidden => e
+        abort "Error: wrong GitHub token"
+      rescue Github::Error::NotFound => e
+        value = nil
+      end
+      value
+    end
+
+    def changelog_from_pr(pr)
+      default = "- #{pr['title']}"
+
+      body = pr.body.body
+      return default unless body
+
+      matcher = body.gsub(/\r\n?/, "\n").match(/.*#+\s+(changelog|release notes)(^\n)*\n(?<changes>(.*\n?(?!#))+)/i)
+      return default unless matcher && matcher.names.include?('changes')
+
+      matcher['changes'].strip
+    end
+
+    def connected_issues_from_pr(pr)
+      body = pr.body
+      return [] unless body
+
+      body.scan(/((connect|connects|fix|fixes|address|addresses):?\s*(to)?:?\s*#(?<number>\d+))/im).reject(&:nil?).map(&:last).flatten
+    end
+
+    def date_from_commit(commit)
+      return nil unless commit
+      date = commit["committer"]["date"]
+      date = Chronic.parse(date)
+    end
+
+    def find_commit_for_reference(ref)
+      return nil unless ref && ref["object"] && ref["object"]["sha"]
+      sha = ref["object"]["sha"]
+      commit = check_github_response() { github.git_data.commits.get user, repo_name, URI::encode(sha) }
+      unless commit
+        tag = check_github_response() { github.git_data.tags.get user, repo_name, URI::encode(sha) }
+        sha = (tag && tag.object) ? tag.object.sha : nil
+        commit = check_github_response() { github.git_data.commits.get user, repo_name, URI::encode(sha) } if sha
+      end
+      commit
+    end
+
+    def find_reference_for_string(ref)
+      reference = check_github_response() { github.git_data.references.get user, repo_name, URI::encode("heads/#{ref}") }
+      reference ||= check_github_response() { github.git_data.references.get user, repo_name, URI::encode("tags/#{ref}") }
+      reference
+    end
+
+    def find_commit_for_string(string)
+      reference = find_reference_for_string(string)
+      return find_commit_for_reference(reference) if reference
+      check_github_response() { github.git_data.commits.get user, repo_name, URI::encode(string) }
+    end
+
+    def date_range_for_references(ref_one, ref_two)
+      return [date_for_string(ref_one), date_for_string(ref_two)]
+    end
+
+    def date_for_string(string)
+      date_from_commit(find_commit_for_string(string)) || parse_string_as_date(string)
+    end
+
+    def parse_string_as_date(string)
+      Chronic.parse(string)
+    end
+
+    # Page through all pulls grabbing only those merged in date range
+    def pull_requests_for_date_range(start_date, end_date)
+      page = 1
+      pulls = []
+
+      # There is a chance that the commit is created slightly earlier than the PR is merged.
+      # Example: merged_at: 2015-11-25T17:31:24+00:00, commit_date: 2015-11-25T17:31:23+00:00
+      end_date += 5
+      start_date += 5
+
+      loop do
+        response_wrapper = check_github_response() { github.pull_requests.list user, repo_name, state: 'closed', sort: 'updated', direction: 'desc', base: 'master', page: page }
+        found_pulls = response_wrapper.to_a
+        found_pulls.select! { |p| p['merged_at'] }
+        break if found_pulls.count == 0
+        stop = false
+        found_pulls.each do |pull|
+          date = Chronic.parse(pull['merged_at'])
+          # puts "PR: #{pull.number} Date: #{date}, Start Date: #{start_date}, End Date: #{end_date}"
+          next if date > end_date
+          if date <= start_date
+            stop = true
+            break
+          end
+          pulls << pull
+        end
+        break if stop
+        page += 1
+      end    
+
+      pulls
+    end
+  end
+end

data/lib/changelog_generator/issue.rb

@@ -0,0 +1,20 @@
+module ChangelogGenerator
+  class Issue
+    attr_accessor :title
+    attr_accessor :number
+
+    def self.from_github_issue(github_issue)
+      self.new({
+        title: github_issue['title'],
+        number: github_issue['number']
+      })
+    end
+
+    def initialize(args)
+      args.each do |k,v|
+        instance_variable_set("@#{k}", v) unless v.nil?
+      end
+    end
+
+  end
+end

data/lib/changelog_generator/pull_request.rb

@@ -0,0 +1,42 @@
+module ChangelogGenerator
+  class PullRequest
+    attr_accessor :title
+    attr_accessor :body
+    attr_accessor :number
+    attr_accessor :changelog_text
+    attr_accessor :head_sha
+    attr_accessor :merged_at
+    attr_accessor :issues
+
+    def self.from_github_pr(github_pr)
+      self.new({
+        title: github_pr['title'],
+        body: github_pr.body.body,
+        number: github_pr['number'],
+        changelog_text: changelog_from_pr(github_pr),
+        head_sha: github_pr.head.sha,
+        merged_at: github_pr.merged_at
+        })
+    end
+
+    def initialize(args)
+      args.each do |k,v|
+        instance_variable_set("@#{k}", v) unless v.nil?
+      end
+    end
+
+    private
+
+    def self.changelog_from_pr(pr)
+      default = "- #{pr['title']}"
+
+      body = pr.body.body
+      return default unless body
+
+      matcher = body.gsub(/\r\n?/, "\n").match(/.*#+\s+(changelog|release notes)(^\n)*\n(?<changes>(.*\n?(?!#))+)/i)
+      return default unless matcher && matcher.names.include?('changes')
+
+      matcher['changes'].strip
+    end
+  end
+end

data/lib/changelog_generator/version.rb

@@ -0,0 +1,3 @@
+module ChangelogGenerator
+  VERSION = "0.1.1"
+end

data/lib/changelog_generator.rb

@@ -0,0 +1,7 @@
+require "changelog_generator/version"
+require "changelog_generator/cli"
+require "changelog_generator/generator"
+
+module ChangelogGenerator
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: github_changes
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Cody Rayment
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-02 00:00:00.000000000 Z
+dependencies:
+- !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: github_api
+  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: chronic
+  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.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- crayment16@gmail.com
+executables:
+- github_changes
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- changelog_generator.gemspec
+- exe/github_changes
+- lib/changelog_generator.rb
+- lib/changelog_generator/cli.rb
+- lib/changelog_generator/generator.rb
+- lib/changelog_generator/issue.rb
+- lib/changelog_generator/pull_request.rb
+- lib/changelog_generator/version.rb
+homepage: 
+licenses: []
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Generate Release Notes
+test_files: []