pr_changelog 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9f16ba9dc24c0c5dabc4c5fca81029b448cfe69b
-  data.tar.gz: e8741e1311983a40178e926ae136827b8dac9762
+  metadata.gz: c723eb18c8ee6a3d5dcb25e055fe439105b7849d
+  data.tar.gz: 74fcb7ed7d34c5b2a5b3aa37536db82449508689
 SHA512:
-  metadata.gz: cc7720777b84d891f0c9c303389e31dc34027359a82e4498f4bacdadcaa01a1c44a88766846e00485f8d01c50d2684c0aa2e206270c090e47e4a8f80d66e3f65
-  data.tar.gz: d6e06054a145f429cb77d931734901ae457b9de5f36b0db45efac1ba6ca3735fbf6f7d44452171ecb38c89684c9ad91e00159f63beb7f9a6e9026ff14fd84672
+  metadata.gz: a12c7d8e34491ac360cb9ef7e945c802658b73bf3e53e23e01385955f4c1340bba39c408dc0ff8b9e7f097fb933e09bd6039a01744895008ca8ec78f34925ab8
+  data.tar.gz: 1668613081f37fa6e4b3bd3daa9921fdb0498acc6796b87c1af20bb32f92186d203326a4af936bdd743e7d39d7a3bd991f510442fc6650ddcbde51931182f278

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pr_changelog (0.3.0)
+    pr_changelog (0.4.0)
 
 GEM
   remote: https://rubygems.org/

data/lib/pr_changelog.rb

@@ -10,6 +10,9 @@ 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/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

@@ -13,7 +13,7 @@ module PrChangelog
 
     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.rb

@@ -11,6 +11,7 @@ module PrChangelog
         -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]
 
@@ -33,7 +34,7 @@ module PrChangelog
     class HelpWanted < StandardError
     end
 
-    attr_reader :format, :from_reference, :to_reference
+    attr_reader :format, :strategy, :from_reference, :to_reference
 
     class CannotDetermineRelease < StandardError
     end
@@ -44,6 +45,8 @@ module PrChangelog
 
       @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)
@@ -62,9 +65,19 @@ module PrChangelog
       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,6 +5,10 @@ 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

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('- ')
+        .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

@@ -9,11 +9,22 @@ module PrChangelog
     end
 
     def last_release
-      git_proxy.git_tags_list.last
+      sorted_tags.last
     end
 
     def last_release_pair
-      git_proxy.git_tags_list.last(2)
+      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.3.0'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pr_changelog
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Felipe Espinoza
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-24 00:00:00.000000000 Z
+date: 2019-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -87,6 +87,7 @@ 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
@@ -94,8 +95,10 @@ files:
 - 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