pr_changelog 0.2.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: dab0c2b8a1d8fbd0d20075ac1bf8068b472f5abd
-  data.tar.gz: 89eb296b69a3acbc79682445a411dac2c6b9dbd8
+SHA256:
+  metadata.gz: f70cebf212d0628887eb6e2918877e9aa4afd8fa592161c48101cf772ad90ace
+  data.tar.gz: ef28138fbe7f31cdf8fbd787b11128ae4a106280ddd85ddb5aa9aefce2f8d560
 SHA512:
-  metadata.gz: 11f056d478fa379d7c20e177519a9ffdf29b4d01a7aab3d9e374eff223310759217b8fafb18d4ecf247a01d5f6ed2947a329c8a51ab7430c65a7b7bca926f7b7
-  data.tar.gz: 42057d5c68c710b313f22e9d7fe8a5edaf7953e9956ea4f4da81131160017bf167504cccd6d50af05c91858f817eaf0de52c4953b067c26df3726707e0a6549d
+  metadata.gz: ec11aeb735c949e902f0ccb64b7039254aa806268476412ec067504a8d064b2df03479ef805e5848df7857d0c394baa46ccd3dffa9c43a00fd56c0f7d441ce87
+  data.tar.gz: 0ab4bf6ab95960ff6f614c0c8b956cd8f86b2002b818593d9b338445cfdf81de524f521ef0e3ae1bdf2300aa98f2e78ce3ad12800044648ec472507141bdef1e

data/.pr_changelog.json

@@ -0,0 +1,3 @@
+{
+  "format": "pretty"
+}

data/Gemfile.lock

@@ -1,28 +1,28 @@
 PATH
   remote: .
   specs:
-    pr_changelog (0.2.0)
+    pr_changelog (0.4.1)
 
 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 (12.3.2)
+    coderay (1.1.3)
+    method_source (1.0.0)
+    minitest (5.15.0)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (13.0.6)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 2.0.1)
-  minitest (~> 5.11.3)
+  bundler (~> 2.3.9)
+  minitest (~> 5.15.0)
   pr_changelog!
-  pry (~> 0.12.2)
-  rake (~> 12.3.2)
+  pry (~> 0.14.1)
+  rake (~> 13.0.6)
 
 BUNDLED WITH
-   2.0.1
+   2.3.9

data/README.md

@@ -100,6 +100,40 @@ Will produce:
   - #60: 👨‍💻 Setup hockeyapp for crash reporting
 ```
 
+It's also possible to not pass any git references if you have sorted git tags. For example, if currently in your project you have the following tags:
+
+```
+$ git tag -l
+0.1.0
+0.1.1
+0.2.0
+0.2.1
+0.2.2
+```
+
+Then you can get the changes from the last release to `'master'` with:
+
+```
+$ pr_changelog
+
+## Changes since 0.2.2 to master
+
+...
+```
+
+If you want to get the changes for the last release (between `0.2.1` and `0.2.2`) you can execute:
+
+```
+$ pr_changelog --last-release
+
+## Changes since 0.2.1 to 0.2.2
+
+...
+```
+
+
+
+
 ## Configuration
 
 Change the emojis or add your own in a `.pr_changelog.json` file:

data/lib/pr_changelog/base_commit_strategy.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module PrChangelog
+  # A "protocol"-like base class for the extracting the change commit strategies
+  class BaseCommitStrategy
+    def parsed_commits
+      raise 'Not implemented'
+    end
+
+    def format_commit(_commit_line)
+      raise 'Not implemented'
+    end
+  end
+end

data/lib/pr_changelog/change_line.rb

@@ -5,15 +5,17 @@ module PrChangelog
   class ChangeLine
     attr_reader :pr_number, :tag, :title
 
+    SKIP_CI_PATTERN = /\s*\[(skip ci)\]\s*/im
+
     def initialize(pr_number, tag, title)
       @pr_number = pr_number
       @tag = tag
-      @title = title
+      @title = title.gsub(SKIP_CI_PATTERN, '')
     end
 
     def to_s
       if tag.nil?
-        "- #{pr_number}: #{title.first_lowercase}"
+        "- #{pr_number}: #{formatted_title}"
       else
         "- #{pr_number}: #{tag}: #{title.first_lowercase}"
       end

data/lib/pr_changelog/cli/args.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module PrChangelog
+  class CLI
+    # A simple wrapper over ARGV that is passed to the CLI class
+    class Args
+      def initialize(raw_args)
+        @raw_args = raw_args
+      end
+
+      def include?(flag)
+        raw_args.include?(flag)
+      end
+
+      def value_for(flag)
+        return nil unless raw_args.index(flag)
+
+        next_index = raw_args.index(flag) + 1
+        value = raw_args.delete_at(next_index)
+        raw_args.delete(flag)
+        value
+      end
+
+      def include_flags?(flag, flag_variation)
+        include?(flag) || include?(flag_variation)
+      end
+
+      def last(number)
+        raw_args.last(number)
+      end
+
+      attr_reader :raw_args
+    end
+  end
+end

data/lib/pr_changelog/cli.rb

@@ -9,13 +9,23 @@ module PrChangelog
       [Options]
 
         -h, --help\tShow this help
+        -l, --last-release\tSets from_reference and to_reference to the last release and the previous one
         --format FORMAT_NAME\t(default "plain"), options ("pretty", "plain")
+        --strategy STRATEGY_NAME\tIs the strategy used to merge pull requests (default "merge"), options ("merge", "squash").
 
       [Examples]
 
-        Listing the changes for the last release (since the previous to the last one)
+        Listing the unreleased changes
 
         $ pr_changelog
+
+        Listing the changes from the last release
+
+        $ pr_changelog --last-release
+
+        Listing the changes between two given git references
+
+        $ pr_changelog reference_A reference_B
     HELP
 
     class InvalidInputs < StandardError
@@ -24,29 +34,50 @@ module PrChangelog
     class HelpWanted < StandardError
     end
 
-    attr_reader :format, :from_reference, :to_reference
+    attr_reader :format, :strategy, :from_reference, :to_reference
 
-    def initialize(args)
-      throw HelpWanted if args.include?('--help') || args.include?('-h')
+    class CannotDetermineRelease < StandardError
+    end
 
-      @format = PrChangelog.config.default_format
-      if args.include?('--format')
-        next_index = args.index('--format') + 1
-        @format = args.delete_at(next_index)
-        args.delete('--format')
-      end
+    def initialize(raw_args, releases = nil)
+      args = Args.new(raw_args)
+      raise HelpWanted if args.include_flags?('-h', '--help')
+
+      @format = args.value_for('--format') || PrChangelog.config.default_format
+
+      @strategy = args.value_for('--strategy') || PrChangelog.config.default_strategy
+
+      @releases = releases || Releases.new
 
       @from_reference, @to_reference = args.last(2)
+      @from_reference ||= @releases.last_release
       @to_reference ||= 'master'
 
+      if args.include_flags?('-l', '--last-release')
+        last_release_pair = @releases.last_release_pair
+        raise CannotDetermineRelease if last_release_pair.length != 2
+
+        @from_reference, @to_reference = last_release_pair
+      end
+
       return if @from_reference && @to_reference
 
-      throw InvalidInputs.new
+      raise InvalidInputs
+    end
+
+    def build_strategy
+      if strategy == 'merge'
+        MergeCommitStrategy.new(from_reference, to_reference)
+      elsif strategy == 'squash'
+        SquashCommitStrategy.new(from_reference, to_reference)
+      else
+        raise "Strategy '#{strategy}' not recognized."
+      end
     end
 
     def run
-      changes = NotReleasedChanges.new(from_reference, to_reference)
-      puts "## Changes since #{from_reference} to #{to_reference}\n\n"
+      changes = NotReleasedChanges.new(build_strategy)
+      puts "## Changes since #{from_reference} to #{to_reference} (#{strategy})\n\n"
 
       if format == 'pretty'
         puts changes.grouped_formatted_changelog

data/lib/pr_changelog/config.rb

@@ -7,6 +7,7 @@ module PrChangelog
   class Config
     DEFAULTS = {
       format: 'plain',
+      strategy: 'merge',
       tags: [
         {
           prefix: 'feature',
@@ -49,6 +50,10 @@ module PrChangelog
       loaded_data[:format] || DEFAULTS[:format]
     end
 
+    def default_strategy
+      loaded_data[:strategy] || DEFAULTS[:strategy]
+    end
+
     def tags
       loaded_data[:tags] || DEFAULTS[:tags]
     end

data/lib/pr_changelog/git_proxy.rb

@@ -5,8 +5,16 @@ module PrChangelog
   class GitProxy
     LOG_FORMAT = '- %cn: %s%n%w(80, 2, 2)%b'
 
+    def commits_between(base_ref, current_ref)
+      `git log #{base_ref}..#{current_ref} --format='#{LOG_FORMAT}'`
+    end
+
     def merge_commits_between(base_ref, current_ref)
       `git log --merges #{base_ref}..#{current_ref} --format='#{LOG_FORMAT}'`
     end
+
+    def git_tags_list
+      `git tag --list`.split("\n")
+    end
   end
 end

data/lib/pr_changelog/merge_commit_strategy.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module PrChangelog
+  # A strategy that given two references will return the filtered commit changes
+  # based on the merge commits
+  class MergeCommitStrategy < BaseCommitStrategy
+    MERGE_COMMIT_FORMAT = /Merge pull request (?<pr_number>#\d+) .*/.freeze
+    TAGGED_TITLE = /^(?<tag>.+):\s*(?<title>.+)$/.freeze
+
+    attr_reader :base_ref, :current_ref, :git_proxy
+
+    def initialize(base_ref, current_ref, git_proxy = GitProxy.new)
+      @base_ref    = base_ref
+      @current_ref = current_ref
+      @git_proxy   = git_proxy
+    end
+
+    def parsed_commits
+      merge_commits_not_merged_into_base_ref
+        .split("\n- ")
+        .reject(&:empty?)
+        .map { |e| e.split("\n") }
+        .select { |pair| pair.count == 2 }
+    end
+
+    def format_commit(commit_info)
+      github_commit_title = commit_info.first
+      commit_title = commit_info.last
+
+      pr_number = pull_request_number_for(github_commit_title)
+      commit_title.strip!
+      match = commit_title.match(TAGGED_TITLE)
+      if match
+        ChangeLine.new(pr_number, match[:tag], match[:title])
+      else
+        ChangeLine.new(pr_number, nil, commit_title)
+      end
+    end
+
+    private
+
+    def merge_commits_not_merged_into_base_ref
+      git_proxy.merge_commits_between(base_ref, current_ref)
+    end
+
+    def pull_request_number_for(github_commit_title)
+      md = github_commit_title.match(MERGE_COMMIT_FORMAT)
+      md[:pr_number] if md
+    end
+  end
+end

data/lib/pr_changelog/not_released_changes.rb

@@ -4,15 +4,10 @@ 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
-    MERGE_COMMIT_FORMAT = /Merge pull request (?<pr_number>#\d+) .*/.freeze
-    TAGGED_TITLE = /^(?<tag>.+):\s*(?<title>.+)$/.freeze
+    attr_reader :commits_strategy
 
-    attr_reader :base_ref, :current_ref, :git_proxy
-
-    def initialize(base_ref, current_ref, git_proxy = GitProxy.new)
-      @base_ref    = base_ref
-      @current_ref = current_ref
-      @git_proxy   = git_proxy
+    def initialize(commits_strategy)
+      @commits_strategy = commits_strategy
     end
 
     def emoji_tags
@@ -48,37 +43,9 @@ module PrChangelog
     end
 
     def parsed_change_list
-      @parsed_change_list ||= parsed_merge_commits.map do |pair|
-        format_merge_commit(pair.first, pair.last)
+      @parsed_change_list ||= commits_strategy.parsed_commits.map do |commit_info|
+        commits_strategy.format_commit(commit_info)
       end
     end
-
-    def parsed_merge_commits
-      merge_commits_not_merged_into_base_ref
-        .split('- ')
-        .reject(&:empty?)
-        .map { |e| e.split("\n") }
-        .select { |pair| pair.count == 2 }
-    end
-
-    def format_merge_commit(github_commit_title, commit_title)
-      pr_number = pull_request_number_for(github_commit_title)
-      commit_title.strip!
-      match = commit_title.match(TAGGED_TITLE)
-      if match
-        ChangeLine.new(pr_number, match[:tag], match[:title])
-      else
-        ChangeLine.new(pr_number, nil, commit_title)
-      end
-    end
-
-    def merge_commits_not_merged_into_base_ref
-      git_proxy.merge_commits_between(base_ref, current_ref)
-    end
-
-    def pull_request_number_for(github_commit_title)
-      md = github_commit_title.match(MERGE_COMMIT_FORMAT)
-      md[:pr_number] if md
-    end
   end
 end

data/lib/pr_changelog/releases.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module PrChangelog
+  class Releases
+    attr_reader :git_proxy
+
+    def initialize(git_proxy = GitProxy.new)
+      @git_proxy = git_proxy
+    end
+
+    def last_release
+      sorted_tags.last
+    end
+
+    def last_release_pair
+      sorted_tags.last(2)
+    end
+
+    private
+
+    def sorted_tags
+      git_proxy.git_tags_list.sort_by { |tag| tag_value(tag) }
+    end
+
+    def tag_value(tag)
+      components = tag.split('.')
+      components[0].to_i * 100_000 + components[1].to_i * 1_000 + components[2].to_i
+    end
+  end
+end

data/lib/pr_changelog/squash_commit_strategy.rb

@@ -0,0 +1,56 @@
+
+# frozen_string_literal: true
+
+module PrChangelog
+  # A strategy to get the changes between the two references based on the
+  # squash commits
+  class SquashCommitStrategy < BaseCommitStrategy
+    SQUASH_COMMIT_FORMAT = /^GitHub( Enterprise)?: (?<title>.+) \((?<pr_number>#\d+)\)$/.freeze
+    TAGGED_TITLE = /^(?<tag>[^:]+):\s*(?<title>.+)$/.freeze
+
+    attr_reader :base_ref, :current_ref, :git_proxy
+
+    def initialize(base_ref, current_ref, git_proxy = GitProxy.new)
+      @base_ref    = base_ref
+      @current_ref = current_ref
+      @git_proxy   = git_proxy
+    end
+
+    def parsed_commits
+      commits_not_merged_into_base_ref
+        .split('- ')
+        .reject(&:empty?)
+        .map { |e| e.split("\n") }
+        .map(&:first)
+        .select { |line| line.match(SQUASH_COMMIT_FORMAT) }
+    end
+
+    def format_commit(commit_line)
+      pr_number = pull_request_number_for(commit_line)
+      commit_title = pull_request_title_for(commit_line)
+      commit_title.strip!
+      match = commit_title.match(TAGGED_TITLE)
+      if match
+        ChangeLine.new(pr_number, match[:tag], match[:title])
+      else
+        ChangeLine.new(pr_number, nil, commit_title)
+      end
+    end
+
+    private
+
+    def commits_not_merged_into_base_ref
+      git_proxy.commits_between(base_ref, current_ref)
+    end
+
+    def pull_request_number_for(github_commit_title)
+      md = github_commit_title.match(SQUASH_COMMIT_FORMAT)
+      md[:pr_number] if md
+    end
+
+    def pull_request_title_for(github_commit_title)
+      md = github_commit_title.match(SQUASH_COMMIT_FORMAT)
+      md[:title] if md
+    end
+  end
+end

data/lib/pr_changelog/version.rb

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

data/lib/pr_changelog.rb

@@ -3,11 +3,16 @@
 require 'pr_changelog/version'
 require 'pr_changelog/config'
 require 'pr_changelog/extensions/string'
+require 'pr_changelog/releases'
+require 'pr_changelog/cli/args'
 require 'pr_changelog/cli'
 require 'pr_changelog/git_proxy'
 require 'pr_changelog/tag'
 require 'pr_changelog/change_line'
 require 'pr_changelog/grouped_changes'
+require 'pr_changelog/base_commit_strategy'
+require 'pr_changelog/merge_commit_strategy'
+require 'pr_changelog/squash_commit_strategy'
 require 'pr_changelog/not_released_changes'
 
 # Main module

data/pr_changelog.gemspec

@@ -26,8 +26,8 @@ Gem::Specification.new do |spec|
   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.11.3'
-  spec.add_development_dependency 'pry', '~> 0.12.2'
-  spec.add_development_dependency 'rake', '~> 12.3.2'
+  spec.add_development_dependency 'bundler', '~> 2.3.9'
+  spec.add_development_dependency 'minitest', '~> 5.15.0'
+  spec.add_development_dependency 'pry', '~> 0.14.1'
+  spec.add_development_dependency 'rake', '~> 13.0.6'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pr_changelog
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Felipe Espinoza
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-01-22 00:00:00.000000000 Z
+date: 2022-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,57 +16,57 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.1
+        version: 2.3.9
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.1
+        version: 2.3.9
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.11.3
+        version: 5.15.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.11.3
+        version: 5.15.0
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.2
+        version: 0.14.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.2
+        version: 0.14.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.3.2
+        version: 13.0.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.3.2
-description: 
+        version: 13.0.6
+description:
 email:
 - felipe.espinoza@schibsted.com
 executables:
@@ -75,6 +75,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".pr_changelog.json"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -86,13 +87,18 @@ files:
 - bin/setup
 - exe/pr_changelog
 - lib/pr_changelog.rb
+- lib/pr_changelog/base_commit_strategy.rb
 - lib/pr_changelog/change_line.rb
 - lib/pr_changelog/cli.rb
+- lib/pr_changelog/cli/args.rb
 - lib/pr_changelog/config.rb
 - lib/pr_changelog/extensions/string.rb
 - lib/pr_changelog/git_proxy.rb
 - lib/pr_changelog/grouped_changes.rb
+- lib/pr_changelog/merge_commit_strategy.rb
 - lib/pr_changelog/not_released_changes.rb
+- lib/pr_changelog/releases.rb
+- lib/pr_changelog/squash_commit_strategy.rb
 - lib/pr_changelog/tag.rb
 - lib/pr_changelog/version.rb
 - pr_changelog.gemspec
@@ -100,7 +106,7 @@ homepage: https://github.com/schibsted/pr_changelog
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -115,9 +121,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.3
-signing_key: 
+rubygems_version: 3.3.6
+signing_key:
 specification_version: 4
 summary: A script to generate nice changelogs from your merged PRs
 test_files: []