pr_changelog 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '02288b5d68d67aba8bfeab47b86537f777f650c2'
-  data.tar.gz: a3ac3dc43ce78f8c336c17c9ffaab36d19cc2d0a
+  metadata.gz: 0d8b03e0c652b5e8c54545bda41fc8db5892f5c4
+  data.tar.gz: 7d03c9f0832e52c65fe6cf40da38f5cf1a234622
 SHA512:
-  metadata.gz: fdb606a52d240f3c1ae8f20a2794ef1b5f01ed996133cccf38e6f7824574e2fa25e6ec05638cdef4274ce1c005790daf4a70d2d9b861f4b76d3eefd8cc20c022
-  data.tar.gz: f96c549aed74907e06404ace2e8e525136da7f3c56d5a86d1963cd2ef9f64316cacf0fde0c81a02df95344c17e9cfafe2c58cd3e4dbd9634c34fb91025798ec5
+  metadata.gz: 16911cf9a8c6e3a29d85fd0b7534f082fc1b4a229ae5ee244846466fb57aa0d8186ac925d3208eb1e03a53e368ef1ed447c28d266d7ad60a3f6aa9dddc2f66f5
+  data.tar.gz: 2abab755538b3cb4baef5d34945f84550fafdb0c4ac737ab4252a1e890bb2de09cafd5f48cfedadb12baa5b19f2022a181d55306bd5758d4f14d8736685d500d

data/Gemfile.lock

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

data/README.md

@@ -1,6 +1,22 @@
 # PR Changelog
 
-A script to generate a nice list of changes given two git references.
+A script to generate a nice list of changes given two git references, like so:
+
+```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
+```
 
 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.
 
@@ -42,6 +58,26 @@ 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 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
+```
+
+or
+
+```
+$ pr_changelog --format pretty 0.3.0 0.5.0
+```
+
 Will produce:
 
 ```markdown
@@ -60,26 +96,6 @@ Will produce:
   - #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.

data/lib/pr_changelog/change_line.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module PrChangelog
+  # Represents a single change entry in the changelog
+  class ChangeLine
+    attr_reader :pr_number, :tag, :title
+
+    def initialize(pr_number, tag, title)
+      @pr_number = pr_number
+      @tag = tag
+      @title = title
+    end
+
+    def to_s
+      if tag.nil?
+        "- #{pr_number}: #{title.first_lowercase}"
+      else
+        "- #{pr_number}: #{tag}: #{title.first_lowercase}"
+      end
+    end
+
+    def formatted_title
+      title.first_uppercase
+    end
+
+    def emojified_for(tag_object)
+      "- #{pr_number}: #{tag_object.emoji} #{formatted_title}"
+    end
+  end
+end

data/lib/pr_changelog/cli.rb

@@ -9,7 +9,7 @@ module PrChangelog
       [Options]
 
         -h, --help\tShow this help
-        --format FORMAT_NAME\t(default "pretty"), options ("pretty", "plain")
+        --format FORMAT_NAME\t(default "plain"), options ("pretty", "plain")
 
       [Examples]
 
@@ -31,10 +31,10 @@ module PrChangelog
 
     def run
       changes = NotReleasedChanges.new(from_reference, to_reference)
-      if format == 'plain'
-        puts changes.formatted_changelog
-      else
+      if format == 'pretty'
         puts changes.grouped_formatted_changelog
+      else
+        puts changes.formatted_changelog
       end
     end
   end

data/lib/pr_changelog/extensions/string.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# Some useful extensions on string
+class String
+  def first_uppercase
+    return self unless length > 2
+
+    "#{self[0].upcase}#{self[1, length]}"
+  end
+
+  def first_lowercase
+    return self unless length > 2
+
+    "#{self[0].downcase}#{self[1, length]}"
+  end
+end

data/lib/pr_changelog/git_proxy.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module PrChangelog
+  # A boundary class between git and the rest of the gem
+  class GitProxy
+    LOG_FORMAT = '- %cn: %s%n%w(80, 2, 2)%b'
+
+    def merge_commits_between(base_ref, current_ref)
+      `git log --merges #{base_ref}..#{current_ref} --format='#{LOG_FORMAT}'`
+    end
+  end
+end

data/lib/pr_changelog/grouped_changes.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module PrChangelog
+  # A class to group change lines by tag
+  class GroupedChanges
+    attr_reader :changes, :tags
+
+    def initialize(changes, tags)
+      @changes = changes
+      @tags = tags
+    end
+
+    def to_s
+      new_hash = {}
+      grouped_changes.each do |tag, change_lines|
+        new_key = tag.formatted_title
+        new_hash[new_key] = change_lines.map do |change_line|
+          change_line.emojified_for(tag)
+        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.strip.chomp
+    end
+
+    private
+
+    def grouped_changes
+      @grouped_changes ||= changes.group_by do |change_line|
+        tags[change_line&.tag&.downcase] || tags['unclassified']
+      end.sort do |first_group, second_group|
+        first_group[0].sort_index <=> second_group[0].sort_index
+      end
+    end
+  end
+end

data/lib/pr_changelog/not_released_changes.rb

@@ -4,20 +4,8 @@ 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)
-
+    MERGE_COMMIT_FORMAT = /Merge pull request (?<pr_number>#\d+) .*/.freeze
+    TAGGED_TITLE = /^(?<tag>.+):\s*(?<title>.+)$/.freeze
     EMOJI_TAGS = {
       'feature' => Tag.new('⭐️', 'New features', 0),
       'fix' => Tag.new('🐛', 'Fixes', 1),
@@ -26,93 +14,63 @@ module PrChangelog
       'unclassified' => Tag.new('❓', 'Unclassified', 5)
     }.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 formatted_changelog
-      if formatted_change_list.positive?
-        formatted_change_list.join("\n")
+      if parsed_change_list.count.positive?
+        parsed_change_list.map(&:to_s).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
+      if parsed_change_list.count.positive?
+        GroupedChanges.new(parsed_change_list, EMOJI_TAGS).to_s
       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
+    def parsed_change_list
+      @parsed_change_list ||= parsed_merge_commits.map do |pair|
+        format_merge_commit(pair.first, pair.last)
+      end
     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") }
+        .select { |pair| pair.count == 2 }
     end
 
     def format_merge_commit(github_commit_title, commit_title)
       pr_number = pull_request_number_for(github_commit_title)
-
-      "- #{pr_number}: #{commit_title.strip}"
+      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 log --merges #{base_ref}..#{current_ref} --format='#{LOG_FORMAT}'`
+      git_proxy.merge_commits_between(base_ref, current_ref)
     end
 
     def pull_request_number_for(github_commit_title)
-      md = github_commit_title.match(GITHUB_MERGE_COMMIT_FORMAT)
+      md = github_commit_title.match(MERGE_COMMIT_FORMAT)
       md[:pr_number] if md
     end
   end

data/lib/pr_changelog/tag.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module PrChangelog
+  # A way to classify particular change lines
+  class Tag
+    attr_reader :emoji, :title, :sort_index
+
+    def initialize(emoji, title, sort_index)
+      @emoji = emoji
+      @title = title
+      @sort_index = sort_index
+    end
+
+    def formatted_title
+      "[#{title}]"
+    end
+  end
+end

data/lib/pr_changelog/version.rb

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

data/lib/pr_changelog.rb

@@ -1,7 +1,12 @@
 # frozen_string_literal: true
 
 require 'pr_changelog/version'
+require 'pr_changelog/extensions/string'
 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/not_released_changes'
 
 # Main module

data/pr_changelog.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'bundler', '~> 2.0.1'
-  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'minitest', '~> 5.11.3'
   spec.add_development_dependency 'pry', '~> 0.12.2'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '~> 12.3.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pr_changelog
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Felipe Espinoza
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 5.11.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 5.11.3
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.2
 description: 
 email:
 - felipe.espinoza@schibsted.com
@@ -86,8 +86,13 @@ files:
 - bin/setup
 - exe/pr_changelog
 - lib/pr_changelog.rb
+- lib/pr_changelog/change_line.rb
 - lib/pr_changelog/cli.rb
+- lib/pr_changelog/extensions/string.rb
+- lib/pr_changelog/git_proxy.rb
+- lib/pr_changelog/grouped_changes.rb
 - lib/pr_changelog/not_released_changes.rb
+- lib/pr_changelog/tag.rb
 - lib/pr_changelog/version.rb
 - pr_changelog.gemspec
 homepage: https://github.com/schibsted/pr_changelog