git-chlog 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0252df630af5256b8188c00be555ecd264e9fb07
+  data.tar.gz: 426a0cc5da377b2ec0d793a9cd7e7d50019a05a9
+SHA512:
+  metadata.gz: d645e2fed6de7f9eb9ef5d5b55476537b787d5c7b6c33837733a538eff54cd79469717516a7c3aa1491636fca36960ff6c9bbe650b0d90fea1bf4b108af8dd46
+  data.tar.gz: 5c3d28ec847c5667a765a5006b8b0141ac2e7695ef04b381c280990b12c2a40177045932746942b6a34cb3f77114b2020220e7025503405be0237fdf395572f9

data/.gitignore

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

data/.rspec

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

data/.travis.yml

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

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Change Log
+## [v0.1.0](https://github.com/teohm/git-chlog/tree/v0.1.0)
+Released on 2017-11-01
+
+[Full Changelog](https://github.com/teohm/git-chlog/compare/6bcc2fb6e...v0.1.0)
+*  2017-11-01 - fix :allowed_push_host metadata in gemspec  [#3](https://github.com/teohm/git-chlog/pull/3)
+*  2017-11-01 - Prepare release 0.1.0  [#2](https://github.com/teohm/git-chlog/pull/2)
+*  2017-11-01 - Add git custom command: git-chlog  [#1](https://github.com/teohm/git-chlog/pull/1)
+

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at teohuiming@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Huiming Teo
+
+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,43 @@
+# Git::Chlog
+
+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/git/chlog`. 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 'git-chlog'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install git-chlog
+
+## 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]/git-chlog. 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).
+
+## Code of Conduct
+
+Everyone interacting in the Git::Chlog project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/git-chlog/blob/master/CODE_OF_CONDUCT.md).

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 "git/chlog"
+
+# 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/git-chlog

@@ -0,0 +1,279 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "time"
+
+class MergeRequest
+  attr_reader :id, :title, :date
+
+  def initialize(id:, title:, date:)
+    @id = id
+    @title = title
+    @date = Time.parse(date)
+  end
+end
+
+module CodeHosting
+  def self.build(repo_url)
+    if GitHub.matching_repo_url?(repo_url)
+      GitHub.new(repo_url)
+    else
+      raise "unsupported repo url: #{repo_url}"
+    end
+  end
+
+  class GitHub
+    attr_reader :repo_name
+
+    def self.matching_repo_url?(repo_url)
+      /github\.com/.match?(repo_url)
+    end
+
+    def initialize(github_repo_url)
+      @repo_name = extract_repo_name(github_repo_url)
+    end
+
+    def build_merge_request(raw_commit)
+      MergeRequest.new(
+        id: extract_pull_id(raw_commit[:subject]),
+        title: raw_commit[:body],
+        date: raw_commit[:date]
+      )
+    end
+
+    def is_merge_request?(raw_commit)
+      raw_commit[:subject].start_with?("Merge pull request")
+    end
+
+    def base_url
+      "https://github.com"
+    end
+
+    def merge_request_url(id)
+      [base_url, repo_name, "pull", id].join("/")
+    end
+
+    def diff_url(from:, to:)
+      [base_url, repo_name, "compare", "#{from}...#{to}"].join("/")
+    end
+
+    def tag_url(tag)
+      [base_url, repo_name, "tree", tag].join("/")
+    end
+
+    private
+
+      def extract_repo_name(repo_url)
+        /git@github.com:([^.]+).git/.match(repo_url)&.captures&.first
+      end
+
+      def extract_pull_id(commit_subject)
+        /#(\d+)/.match(commit_subject).captures.first
+      end
+  end
+end
+
+class Release
+  attr_reader :tag, :date
+  attr_accessor :prev_tag
+
+  def initialize(tag:, date:)
+    @tag = tag
+    @date = Time.parse(date)
+  end
+
+  def version_number
+    tag.sub("v", "")
+  end
+
+  def <=>(other)
+    date <=> other.date
+  end
+end
+
+module GitRepo
+  def self.origin_remote_url
+    `git remote get-url origin`.strip
+  end
+
+  def self.first_commit_sha
+    `git rev-list --max-parents=0 HEAD`.strip[0...9]
+  end
+
+  def self.prev_tag(current_tag)
+    `git log --format="%D" #{current_tag}~1`
+      .split("\n")
+      .select { |line| line.start_with?("tag:") }
+      .first
+      &.match(/tag: ([^,]+)/)&.captures&.first
+  end
+
+  def self.load_releases
+    LoadReleases.new(git_repo: self).call
+  end
+
+  def self.load_merged_requests(release, code_hosting)
+    LoadMergedRequests.new(
+      release: release, code_hosting: code_hosting
+    ).call
+  end
+
+  class LoadReleases
+    attr_reader :git_repo
+
+    def initialize(git_repo:)
+      @git_repo = git_repo
+    end
+
+    def call
+      raw_git_tag_data
+        .map { |release_params| Release.new(release_params) }
+        .map { |release|
+          release.prev_tag = git_repo.prev_tag(release.tag)
+          release
+        }
+        .sort
+        .reverse
+    end
+
+    private
+
+      def raw_git_tag_data
+        `git tag --format='%(refname:short)|%(creatordate:iso8601)'`
+          .split("\n")
+          .map { |line| Hash[[:tag, :date].zip(line.split("|"))] }
+      end
+  end
+
+  class LoadMergedRequests
+    attr_reader :release, :code_hosting
+
+    def initialize(release:, code_hosting:)
+      @release = release
+      @code_hosting = code_hosting
+    end
+
+    def call
+      raw_git_merge_commits
+        .select { |raw_commit| is_merge_request?(raw_commit) }
+        .map { |raw_commit| build_merge_request(raw_commit) }
+    end
+
+    private
+
+      def raw_git_merge_commits
+        `git log --merges --pretty="%aI|%s|%b" #{tag_range}`
+          .split("\n")
+          .map { |line| Hash[[:date, :subject, :body].zip(line.split("|"))] }
+          .select { |m| !m[:subject].nil? }
+      end
+
+      def tag_range
+        [release.tag, release.prev_tag].compact.join("...")
+      end
+
+      def is_merge_request?(raw_commit)
+        code_hosting.is_merge_request?(raw_commit)
+      end
+
+      def build_merge_request(raw_commit)
+        code_hosting.build_merge_request(raw_commit)
+      end
+  end
+end
+
+class IssueTracker
+  class PivotalTracker
+    def self.decorate_issue(text)
+      text.gsub(/#(\d+)/,
+        "[#\\1](https://www.pivotaltracker.com/story/show/\\1)")
+    end
+  end
+end
+
+class PrintChangeLog
+  attr_reader :code_hosting, :git_repo, :issue_tracker, :config
+
+  DEFAULT_CONFIG = {
+    title: "# Change Log",
+    diff_url_label: "Full Changelog"
+  }.freeze
+
+  def initialize(code_hosting:, git_repo:, issue_tracker:, config: {})
+    @code_hosting = code_hosting
+    @git_repo = git_repo
+    @issue_tracker = issue_tracker
+    @config = DEFAULT_CONFIG.merge(config)
+  end
+
+  def call
+    with_output do |out|
+      out.puts config[:title]
+
+      until releases.empty? do
+        release = releases.shift
+
+        print_release_heading(out, release)
+        out.puts
+
+        print_full_changelog_link(out, release)
+
+        merged_requests(release).each do |merge_request|
+          print_merged_request(out, merge_request)
+        end
+        out.puts
+      end
+    end
+  end
+
+  private
+
+    def print_release_heading(out, release)
+      out.puts("## [#{release.tag}](#{code_hosting.tag_url(release.tag)})")
+      out.puts("Released on #{format_date(release.date)}")
+    end
+
+    def print_full_changelog_link(out, release)
+      prev_tag = release.prev_tag || git_repo.first_commit_sha
+      out.puts(
+        "[#{config[:diff_url_label]}]"\
+        "(#{code_hosting.diff_url(from: prev_tag, to: release.tag)})"
+      )
+    end
+
+    def print_merged_request(out, merge_request)
+      out.puts(
+        "* " \
+        " #{format_date(merge_request.date)}" \
+        " - #{link_to_issue_tracker(merge_request.title)} " \
+        " [##{merge_request.id}]"\
+        "(#{code_hosting.merge_request_url(merge_request.id)})"
+      )
+    end
+
+    def format_date(date)
+      date.strftime("%F")
+    end
+
+    def link_to_issue_tracker(title)
+      issue_tracker.decorate_issue(title)
+    end
+
+    def releases
+      @_releases ||= git_repo.load_releases
+    end
+
+    def merged_requests(release)
+      git_repo.load_merged_requests(release, code_hosting)
+    end
+
+    def with_output
+      yield(STDOUT.to_io)
+    end
+end
+
+PrintChangeLog.new(
+  code_hosting: CodeHosting.build(GitRepo.origin_remote_url),
+  git_repo: GitRepo,
+  issue_tracker: IssueTracker::PivotalTracker
+).call

data/git-chlog.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "git/chlog/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "git-chlog"
+  spec.version       = Git::Chlog::VERSION
+  spec.authors       = ["Huiming Teo"]
+  spec.email         = ["teohuiming@gmail.com"]
+
+  spec.summary       = %q{Print changelog for PR-based git repo.}
+  spec.description   = %q{This gem provides a git custom command `git chlog` to print changelog with a list of merged pull-requests grouped by tags in a git repository.}
+  spec.homepage      = "https://github.com/teohm/git-chlog"
+  spec.license       = "MIT"
+
+  if spec.respond_to?(:metadata=)
+    spec.metadata = {
+      "allowed_push_host" => "https://rubygems.org",
+      "bug_tracker_uri" => "http://github.com/teohm/git-chlog/issues",
+      "changelog_uri" => "https://github.com/teohm/git-chlog/blob/master/CHANGELOG.md",
+      "homepage_uri" => "https://github.com/teohm/git-chlog",
+      "source_code_uri" => "https://github.com/teohm/git-chlog"
+    }
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/git/chlog/version.rb

@@ -0,0 +1,5 @@
+module Git
+  module Chlog
+    VERSION = "0.1.0"
+  end
+end

data/lib/git/chlog.rb

@@ -0,0 +1,7 @@
+require "git/chlog/version"
+
+module Git
+  module Chlog
+    # Your code goes here...
+  end
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: git-chlog
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Huiming Teo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: This gem provides a git custom command `git chlog` to print changelog
+  with a list of merged pull-requests grouped by tags in a git repository.
+email:
+- teohuiming@gmail.com
+executables:
+- git-chlog
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/git-chlog
+- git-chlog.gemspec
+- lib/git/chlog.rb
+- lib/git/chlog/version.rb
+homepage: https://github.com/teohm/git-chlog
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  bug_tracker_uri: http://github.com/teohm/git-chlog/issues
+  changelog_uri: https://github.com/teohm/git-chlog/blob/master/CHANGELOG.md
+  homepage_uri: https://github.com/teohm/git-chlog
+  source_code_uri: https://github.com/teohm/git-chlog
+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.6.13
+signing_key: 
+specification_version: 4
+summary: Print changelog for PR-based git repo.
+test_files: []