changelogerator 0.9.1 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b7471810cc9cef7c45a8e3e299797131a6535eb3719160b27911f622ed9edc3
-  data.tar.gz: 7ba7b175da8540b9faefba07510736f484380ae698aa910480c69de4647220c5
+  metadata.gz: cf5410924ba8561481f9ce9130a067d35ce76d42c7b78d002df2059c5b644c6a
+  data.tar.gz: 8567d1755cfa533951d8fdc9567535dd05ca764659c38ee78e21a59783248b79
 SHA512:
-  metadata.gz: c1b900314ed34b4b90de73ad40ebc946aa4e60f40fc3ed9801ad840088739b654452fbe226cf9233bcb881cec2bc7e742c431554cbb2b81209decc769bb2acf9
-  data.tar.gz: b413918b6710e7504f7ac1c750a1bdd1c00788f744c3168e25ff0ba85e1b6c13d985d368b3e50da8d872f047c3e072f6a656dbbda69e0e5a3749d2fe973ce02e
+  metadata.gz: a10fa4370f7fac47801c47896d3a6367f07fd4855c91b032de7798adad612cf164f19a72f0acd9f3185e3944c64236077548d93689116b96ef8c60969b832892
+  data.tar.gz: 4e72e0a82a7231804f6cb99280b12dadef9b210abca249287882fb80ae01ad3b21fbde3c1e1df2c2dd00ef76c9b7e2209c1f061eb6f6dd2aaecc894bbeae6fa7

data/bin/changelogerator

@@ -44,6 +44,13 @@ of the changes between 2 references on your Github project.
     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/changelogerator.gemspec

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'rake'
+
+Gem::Specification.new do |s|
+  s.name = 'changelogerator'
+  s.version = '0.10.1'
+  s.summary = 'Changelog generation/management'
+  s.authors = ['Martin Pugh', 'Wilfried Kopp']
+  s.files = FileList['lib/**/*.rb', 'bin/changelogerator', 'changelogerator.gemspec']
+  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+  s.executables = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.description = 'A utility to fetch the data required to generate a changelog based on change in Github and formatted labels.'
+  s.require_paths = ['lib']
+  s.license = 'AGPL-3.0'
+  s.homepage = 'https://github.com/s3krit/changelogerator'
+  s.add_runtime_dependency 'git_diff_parser', '~> 3'
+  s.add_runtime_dependency 'octokit', '~> 4'
+  s.required_ruby_version = '>= 2.7'
+  s.metadata = { 'rubygems_mfa_required' => 'true' }
+end

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,5 +1,8 @@
 # frozen_string_literal: true
 
+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
 # find all PRs that made up that diff and store them as a list. Also allows
@@ -32,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
@@ -54,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'
@@ -83,16 +80,17 @@ class Changelog
     @repository = @gh.repository(@repo)
     @prefix = prefix
     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
@@ -123,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
@@ -163,6 +177,7 @@ class Changelog
     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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: changelogerator
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.10.1
 platform: ruby
 authors:
 - Martin Pugh
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-11 00:00:00.000000000 Z
+date: 2023-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git_diff_parser
@@ -48,11 +48,15 @@ extensions: []
 extra_rdoc_files: []
 files:
 - bin/changelogerator
+- changelogerator.gemspec
+- 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:
@@ -68,7 +72,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.4.6
 signing_key:
 specification_version: 4
 summary: Changelog generation/management