changelogerator 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b292e9657833099e9623ee12bc856d1212fe047a0fc3da90ef7192ab305c2f6d
-  data.tar.gz: 24fab3a02631ae80b4ab8b810b8aee5b9fd9340280bfce389247dfb19d215ef6
+  metadata.gz: a765967f91e3865aebe4990566bd73cdd310fde94ceade67ca4523486712752c
+  data.tar.gz: 722f348d22b0a44270a6289f1bcf9b48ecb4b5197e6b6f61eddd552058572ea5
 SHA512:
-  metadata.gz: 28564cd68a1ebd4d4917e8f43339551a144edac68fa242ce1b3248e0f123e9835040d8c267e51755bfb0a3e09a26fb22214605ace98212b9bdc573b54c0265a0
-  data.tar.gz: b9c23322c65362bdee0f6535982d4c349bde39092f99457901bebe48d5ba9d77e5484faab552ed81a5f786976024dc68f600eeaa85a34a578a50df6ec560f7dd
+  metadata.gz: 8331c26720ae5168575df385006c13d06dcf592b0250d97bd9d846d8f3cb697a5b82ddbf198fe180422d6e54dc5b05b0cba5a193c16cfc75bcf1849179d553ac
+  data.tar.gz: 9e7b6297c51b47965b103d5ba378a0cdbed04d1fe9cfa7f9190ed79f3d98a538945144bb75ffa78ddf1d71e276dd156f9fd455efb6ab08023e0daf0e7401ac1a

data/bin/changelogerator

@@ -16,12 +16,13 @@ logger.level = Logger::WARN
 logger.debug('Starting')
 
 OptionParser.new do |opts|
-  opts.banner = "
-  Changelogerator helps you generate a template friendly context made of the changes
-  between 2 references on your Github project.
+  opts.banner = 'Changelogerator
+
+This utility helps generate a template friendly context made
+of the changes between 2 references on your Github project.
 
   Usage:
-  changelogerator <repo> [options]"
+  changelogerator <repo> [options]'
 
   opts.on('-v', '--[no-]verbose', 'Run verbosely') do |v|
     @options[:verbose] = v
@@ -43,6 +44,13 @@ OptionParser.new do |opts|
     puts opts
     exit
   end
+
+  opts.on('-V', '--version', 'Show the version') do
+    gemspec = "#{__dir__}/../changelogerator.gemspec"
+    gem = Gem::Specification.load(gemspec)
+    puts format('%<n>s v%<v>s', { v: gem.version, n: gem.name })
+    exit
+  end
 end.parse!
 
 @options[:repo] = ARGV[0]

data/lib/change.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'label'
+
+### A class describe one change that can potentially have several labels
+class Change
+  attr_reader :labels
+
+  def initialize(labels)
+    # Below we test if we got the full data from Octokit or
+    # only some fake data (label names only) from our tests.
+    @labels = labels.map do |label|
+      if label.respond_to?(:name)
+        from_octokit(label)
+      else
+        from_str(label)
+      end
+    end
+
+    @extra = {}
+  end
+
+  def []=(key, value)
+    @extra[key] = value
+  end
+
+  def meta
+    @extra['meta']
+  end
+
+  private
+
+  def from_octokit(label)
+    Label.new(label.name)
+  end
+
+  def from_str(label_name)
+    Label.new(label_name)
+  end
+end

data/lib/changelogerator.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
-require 'pry'
+require 'label'
+require 'change'
 
 # A small wrapper class for more easily generating and manipulating Github/Git
 # changelogs. Given two different git objects (sha, tag, whatever), it will
@@ -34,13 +35,19 @@ class Changelog
       change._links = nil
 
       change[:meta].each_key do |meta_key|
-        current = change[:meta][meta_key]
-
-        meta[meta_key] = {} unless meta[meta_key]
-        meta[meta_key][:min] = current[:value] if !meta[meta_key][:min] || current[:value] < meta[meta_key][:min]
-        meta[meta_key][:max] = current[:value] if !meta[meta_key][:max] || current[:value] > meta[meta_key][:max]
-        meta[meta_key][:count] = 0 unless meta[meta_key][:count]
-        meta[meta_key][:count] += 1
+        aggregate = change[:meta][meta_key]['agg']
+
+        if meta[meta_key]
+          meta[meta_key][:min] = aggregate['min'] if aggregate['min'] < meta[meta_key][:min]
+          meta[meta_key][:max] = aggregate['max'] if aggregate['max'] > meta[meta_key][:max]
+          meta[meta_key][:count] += aggregate['count']
+        else
+          meta[meta_key] = {
+            min: aggregate['min'],
+            max: aggregate['max'],
+            count: aggregate['count']
+          }
+        end
       end
     end
   end
@@ -56,18 +63,6 @@ class Changelog
     nil
   end
 
-  # Return the label code for a change
-  # if the label name matches the expected pattern.
-  # nil otherwise.
-  def self.get_label_code(name)
-    m = match = name.match(/^([a-z])(\d+)-(.*)$/i)
-    if m
-      letter, number, text = match.captures
-      return [letter, number, text]
-    end
-    nil
-  end
-
   ## End of class methods
 
   # github_repo: 'paritytech/polkadot'
@@ -84,16 +79,18 @@ class Changelog
     )
     @repository = @gh.repository(@repo)
     @prefix = prefix
-    @changes = prs_from_ids(pr_ids_from_git_diff(from, to))
+    ids = pr_ids_from_git_diff(from, to)
+    # The following takes very long time
+    @changes = prs_from_ids(ids)
     @changes.map do |c|
-      compute_change_meta(c)
+      self.class.compute_change_meta(c)
     end
 
     compute_global_meta
   end
 
   def add(change)
-    compute_change_meta(change)
+    self.class.compute_change_meta(change)
     prettify_title(change)
     changes.prepend(change)
     @meta = compute_global_meta
@@ -124,25 +121,41 @@ class Changelog
     JSON.fast_generate(commits, opts)
   end
 
-  private
-
   # Compute and attach metadata about one change
-  def compute_change_meta(change)
+  def self.compute_change_meta(change)
     meta = {}
 
-    change.labels.each do |label|
-      letter, number, text = self.class.get_label_code(label.name)
-      next unless letter && number
+    change.labels.each do |lbl|
+      label = Label.new(lbl.name)
+
+      next unless label
+
+      if meta.key?(label.letter)
+        aggregate = meta[label.letter]['agg']
+        aggregate['max'] = label.number if label.number > aggregate['max']
+        aggregate['min'] = label.number if label.number < aggregate['min']
+        aggregate['count'] += 1
+      else
+        meta[label.letter] = {
+          'agg' => {
+            'count' => 1,
+            'max' => label.number,
+            'min' => label.number
+          }
+        }
+      end
 
-      meta[letter] = {
-        value: number.to_i,
-        text: text
+      meta[label.letter]["#{label.letter}#{label.number}"] = {
+        'value' => label.number,
+        'text' => label.description
       }
     end
 
     change['meta'] = meta
   end
 
+  private
+
   # Prepend the repo if @prefix is true
   def prettify_title(pull)
     pull[:pretty_title] = if @prefix
@@ -154,14 +167,17 @@ class Changelog
   end
 
   def pr_ids_from_git_diff(from, to)
-    @gh.compare(@repo, from, to).commits.map do |c|
+    commits = @gh.compare(@repo, from, to).commits
+    commits.map do |c|
       title = c.commit.message.split("\n\n").first
-      next unless title =~ /\(#[0-9]+\)$/
+      regex = /.*#([0-9]+).*$/
+      next unless title =~ regex
 
-      title.gsub(/.*#([0-9]+)\)$/, '\1')
+      title.gsub(regex, '\1')
     end.compact.map(&:to_i)
   end
 
+  # TODO: See if we can make this quicker
   def prs_from_ids(ids)
     batch_size = 100
     prs = []

data/lib/label.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+### Label = Letter + Number [+ Description]
+class Label
+  attr_accessor :letter, :number, :description
+
+  # Return the label letter for a change if the label name matches the expected pattern.
+  # nil otherwise.
+  def parse(label)
+    m = match = label.match(/^([a-z])(\d+)\s*-?\s*(.*)$/i)
+    return nil unless m
+
+    letter, digits, text = match.captures
+    number = digits.to_i
+    [letter, number, text]
+  end
+
+  def initialize(input)
+    raise InvalidInput, 'Invalid, it must be a non-empty string' unless input
+
+    p = parse(input)
+    raise InvalidLabel, format('Invalid label "%<input>s"', { input: input }) unless p
+
+    @letter = p[0].upcase
+    @number = p[1]
+    @description = p[2] unless p[2].empty?
+  end
+
+  ### Implemented for compatibility reasons
+  def name
+    to_str
+  end
+
+  def to_str
+    format('%<l>s%<n>d - %<d>s', { l: @letter, n: @number, d: @description })
+  end
+end
+
+class InvalidLabel < StandardError; end
+
+class InvalidInput < StandardError; end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: changelogerator
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Martin Pugh
+- Wilfried Kopp
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-09 00:00:00.000000000 Z
+date: 2023-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git_diff_parser
@@ -38,7 +39,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4'
-description: Simple helper class for paritytech/polkadot changelogs
+description: A utility to fetch the data required to generate a changelog based on
+  change in Github and formatted labels.
 email:
 executables:
 - changelogerator
@@ -46,11 +48,14 @@ extensions: []
 extra_rdoc_files: []
 files:
 - bin/changelogerator
+- lib/change.rb
 - lib/changelogerator.rb
+- lib/label.rb
 homepage: https://github.com/s3krit/changelogerator
 licenses:
 - AGPL-3.0
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -66,7 +71,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.2.33
 signing_key:
 specification_version: 4
 summary: Changelog generation/management