pr_changelog 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: '02288b5d68d67aba8bfeab47b86537f777f650c2'
+  data.tar.gz: a3ac3dc43ce78f8c336c17c9ffaab36d19cc2d0a
+SHA512:
+  metadata.gz: fdb606a52d240f3c1ae8f20a2794ef1b5f01ed996133cccf38e6f7824574e2fa25e6ec05638cdef4274ce1c005790daf4a70d2d9b861f4b76d3eefd8cc20c022
+  data.tar.gz: f96c549aed74907e06404ace2e8e525136da7f3c56d5a86d1963cd2ef9f64316cacf0fde0c81a02df95344c17e9cfafe2c58cd3e4dbd9634c34fb91025798ec5

data/.gitignore

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

data/.travis.yml

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

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 fespinozacast@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,7 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,28 @@
+PATH
+  remote: .
+  specs:
+    pr_changelog (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    method_source (0.9.2)
+    minitest (5.11.3)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0.1)
+  minitest (~> 5.0)
+  pr_changelog!
+  pry (~> 0.12.2)
+  rake (~> 10.0)
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Felipe Espinoza
+
+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,93 @@
+# PR Changelog
+
+A script to generate a nice list of changes given two git references.
+
+It takes in account all the merged pull request to master between the two given references, then it formats it in a nice consumable way.
+
+To be effective, this script requires that you follow simple conventions:
+
+1. Your pull request titles must be written as changelog entries
+2. (Optional) Your project has git tags for each version you release (example: `0.3.0`)
+3. (Optional) Your pull request titles begin with some sort of tag (`Feature`, `Improvement`, `Fix`, `Internal`)
+
+Then a sample pull request title would be:
+
+> Feature: shake the phone to send feedback email
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pr_changelog'
+```
+
+And then execute:
+
+```shell
+$ bundle
+```
+
+Or install it yourself as:
+
+```shell
+$ gem install pr_changelog
+```
+
+## Usage
+
+To get the changes between to git tags `0.3.0` and `0.5.0`, execute:
+
+```
+$ pr_changelog 0.3.0 0.5.0
+```
+
+Will produce:
+
+```markdown
+## Changes since 0.3.0 to 0.5.0
+
+[New features]
+  - #61: ⭐️ Shake the phone to send feedback email
+
+[Improvements]
+  - #64: 💎 Visual refinements for canvas 2.0
+  - #57: 💎 Memory performance tweaks
+  - #62: 💎 Visual polishing for top stories
+
+[Internal]
+  - #65: 👨‍💻 Add formatting rules for xml files
+  - #60: 👨‍💻 Setup hockeyapp for crash reporting
+```
+
+or
+
+```
+$ pr_changelog --format plain 0.3.0 0.5.0
+```
+
+Will produce something like:
+
+```markdown
+## Changes from 0.3.0 to 0.5.0
+
+- #64: Improvement: visual refinements for canvas 2.0
+- #65: Internal: add formatting rules for xml files
+- #63: Feature: Add Footer story
+- #57: Improvement: Memory performance tweaks
+- #61: Feature: shake the phone to send feedback email
+- #62: Improvement: visual polishing for top stories
+- #60: Internal: setup hockeyapp for crash reporting
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/schibsted/pr_changelog. 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](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the `pr_changelog` project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/schibsted/pr_changelog/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'pr_changelog'
+
+require 'pry'
+Pry.start

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/exe/pr_changelog

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'pr_changelog'
+
+begin
+  PrChangelog::CLI.new(ARGV).run
+rescue StandardError
+  puts PrChangelog::CLI::HELP_TEXT
+end

data/lib/pr_changelog/cli.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module PrChangelog
+  # Used for the implementation of the exposed executable for this gem
+  class CLI
+    HELP_TEXT = <<~HELP
+      Usage: pr_changelog [options] from_reference to_reference
+
+      [Options]
+
+        -h, --help\tShow this help
+        --format FORMAT_NAME\t(default "pretty"), options ("pretty", "plain")
+
+      [Examples]
+
+        Listing the changes for the last release (since the previous to the last one)
+
+        $ pr_changelog
+    HELP
+
+    attr_reader :format, :from_reference, :to_reference
+
+    def initialize(args)
+      @format = 'pretty'
+      if args.include?('--format')
+        next_index = args.index('--format') + 1
+        @format = args.fetch(next_index)
+      end
+      @from_reference, @to_reference = args.last(2)
+    end
+
+    def run
+      changes = NotReleasedChanges.new(from_reference, to_reference)
+      if format == 'plain'
+        puts changes.formatted_changelog
+      else
+        puts changes.grouped_formatted_changelog
+      end
+    end
+  end
+end

data/lib/pr_changelog/not_released_changes.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+module PrChangelog
+  # Calculates a list of not released changes from `base_ref` to `current_ref`
+  # those changes consist of the merged pull-request title
+  class NotReleasedChanges
+    LOG_FORMAT = '- %cn: %s%n%w(80, 2, 2)%b'
+    GITHUB_MERGE_COMMIT_FORMAT = /Merge pull request (?<pr_number>#\d+) .*/.freeze
+    MERGE_BRANCH_COMMIT_FORMAT = /(Merge branch '.*'\s?(into|of)? .*)|(Merge .* branch .*)/.freeze
+    PARSED_MERGE_COMMIT_FORMAT = /^- #(?<pr_number>\d+):\s+(?<tag>[^\s]+):\s*(?<title>.*)$/.freeze
+
+    attr_reader :base_ref, :current_ref
+
+    def initialize(base_ref, current_ref)
+      @base_ref    = base_ref
+      @current_ref = current_ref
+    end
+
+    Tag = Struct.new(:emoji, :title, :sort)
+
+    EMOJI_TAGS = {
+      'feature' => Tag.new('⭐️', 'New features', 0),
+      'fix' => Tag.new('🐛', 'Fixes', 1),
+      'improvement' => Tag.new('💎', 'Improvements', 2),
+      'internal' => Tag.new('👨‍💻', 'Internal', 4),
+      'unclassified' => Tag.new('❓', 'Unclassified', 5)
+    }.freeze
+
+    def formatted_changelog
+      if formatted_change_list.positive?
+        formatted_change_list.join("\n")
+      else
+        "There are no changes since #{base_ref} to #{current_ref}"
+      end
+    end
+
+    def grouped_formatted_changelog
+      changes = formatted_change_list
+      if changes.count.positive?
+
+        grouped_changes = changes.group_by do |change_line|
+          EMOJI_TAGS[tag_from(change_line)] || EMOJI_TAGS['unclassified']
+        end
+
+        sorted_hash = grouped_changes.sort do |first_pair, second_pair|
+          first_pair[0].sort <=> second_pair[0].sort
+        end
+
+        new_hash = {}
+        sorted_hash.each do |tag, change_lines|
+          new_key = "[#{tag.title}]"
+          new_hash[new_key] = change_lines.map do |change_line|
+            emojify_tag_for(change_line)
+          end
+        end
+
+        new_hash.reduce('') do |string, pair|
+          tag   = pair[0]
+          lines = pair[1].map { |l| "  #{l}" }.join("\n")
+          string + "#{tag}\n#{lines}\n\n"
+        end.chomp
+      else
+        "There are no changes since #{base_ref} to #{current_ref}"
+      end
+    end
+
+    def formatted_change_list
+      parsed_merge_commits.map do |pair|
+        format_merge_commit(pair.first, pair.last)
+      end
+    end
+
+    private
+
+    def first_uppercase(line)
+      return line unless line.length > 2
+
+      "#{line[0].upcase}#{line[1, line.length]}"
+    end
+
+    def emojify_tag_for(change_line)
+      match = change_line.match(PARSED_MERGE_COMMIT_FORMAT)
+      return change_line unless match
+
+      emoji_tag = EMOJI_TAGS[match[:tag].downcase].emoji || '❓'
+      "- ##{match[:pr_number]}: #{emoji_tag} #{first_uppercase(match[:title])}"
+    end
+
+    def tag_from(merge_commit)
+      match = merge_commit.match(PARSED_MERGE_COMMIT_FORMAT)
+      return nil unless match
+
+      match[:tag].downcase
+    end
+
+    def parsed_merge_commits
+      merge_commits_not_merged_into_base_ref
+        .split('- ')
+        .reject(&:empty?)
+        .reject { |line| line.match(MERGE_BRANCH_COMMIT_FORMAT) }
+        .map { |e| e.split("\n") }
+    end
+
+    def format_merge_commit(github_commit_title, commit_title)
+      pr_number = pull_request_number_for(github_commit_title)
+
+      "- #{pr_number}: #{commit_title.strip}"
+    end
+
+    def merge_commits_not_merged_into_base_ref
+      `git log --merges #{base_ref}..#{current_ref} --format='#{LOG_FORMAT}'`
+    end
+
+    def pull_request_number_for(github_commit_title)
+      md = github_commit_title.match(GITHUB_MERGE_COMMIT_FORMAT)
+      md[:pr_number] if md
+    end
+  end
+end

data/lib/pr_changelog/version.rb

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

data/lib/pr_changelog.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'pr_changelog/version'
+require 'pr_changelog/cli'
+require 'pr_changelog/not_released_changes'
+
+# Main module
+module PrChangelog
+end

data/pr_changelog.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 'pr_changelog/version'
+
+Gem::Specification.new do |spec|
+  spec.name     = 'pr_changelog'
+  spec.version  = PrChangelog::VERSION
+  spec.authors  = ['Felipe Espinoza']
+  spec.email    = ['felipe.espinoza@schibsted.com']
+
+  spec.summary  = 'A script to generate nice changelogs from your merged PRs'
+  spec.homepage = 'https://github.com/schibsted/pr_changelog'
+  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 do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 2.0.1'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'pry', '~> 0.12.2'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: pr_changelog
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Felipe Espinoza
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-01-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+- !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: 
+email:
+- felipe.espinoza@schibsted.com
+executables:
+- pr_changelog
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/pr_changelog
+- lib/pr_changelog.rb
+- lib/pr_changelog/cli.rb
+- lib/pr_changelog/not_released_changes.rb
+- lib/pr_changelog/version.rb
+- pr_changelog.gemspec
+homepage: https://github.com/schibsted/pr_changelog
+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.2.3
+signing_key: 
+specification_version: 4
+summary: A script to generate nice changelogs from your merged PRs
+test_files: []