easy_changelog 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 236711ac036de2a58700baeceed154cd1bd88366572c6079035709e21d998704
-  data.tar.gz: 48440bccef6c26da9dab7b7ca2194af70a3f2880eb4bd4d540d5af4ab63161f8
+  metadata.gz: 21835b5eb789e18516da3e0999774650180baa9fa09dcc6c5673089b179d2ce9
+  data.tar.gz: 4bbdd3915868d1795114f24139af6989e6d0a24b636ae0eb7b3b5ed2f5e90cf1
 SHA512:
-  metadata.gz: 41e7ac1c2b79337413818350b4f014ba03e966271538c8b009b867c62509ea8ca16b481c4c34a4b7298e32d2284afb961d82b192ed1308a42cfb0bf87a63f3e6
-  data.tar.gz: de76095801aca8f3c54323d357e980b20657334c632d3333644324b4d1cdb51a5445fb782a5f9f035564aff816c2a445aa994e3e992805f9369b5f0c08e8e40d
+  metadata.gz: deb7ac871213f284a3d3e99fff0b20172038b6e946b96d6f0b2d076599673c21df58330841c96925f985a7992fb4ae6e78fd85e4e5a5f8ccde7d5e09039ca4a9
+  data.tar.gz: 5130b516e4e1207bac5dc5b7be5e05d3279dd03aa94e106d44ce8b7b28446385b9fcfcfd9b263f4a9a93129cf29e939b6c5cc3499af3af5125d580ab107847c0

data/.rubocop.yml

@@ -2,6 +2,29 @@ AllCops:
   TargetRubyVersion: 2.6
   NewCops: enable
 
+Lint/EmptyBlock:
+  Exclude:
+    - 'lib/easy_changelog/task_options_parser.rb'
+Metrics/AbcSize:
+  Exclude:
+    - 'lib/easy_changelog/task_options_parser.rb'
+
+Metrics/BlockLength:
+  Exclude:
+    - 'lib/easy_changelog/tasks/changelog.rake'
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Exclude:
+    - 'lib/easy_changelog/configuration.rb'
+    - 'lib/easy_changelog/task_options_parser.rb'
+
+Metrics/ParameterLists:
+  Exclude:
+    - 'lib/easy_changelog/entry.rb'
+
 Style/Documentation:
   Enabled: false
 

data/CHANGELOG.md

@@ -5,3 +5,9 @@
 
 * [#b0faf01](https://github.com/ivan05almeida/easy_changelog/commit/b0faf01):  Initialize EasyChangelog gem. ([@ivan05almeida][])
 * [#1763186](https://github.com/ivan05almeida/easy_changelog/commit/1763186):  Update Readme. ([@ivan05almeida][])
+* [#bec422a](https://github.com/ivan05almeida/easy_changelog/commit/bec422a):  Automate release changelog entries. ([@ivan05almeida][])
+
+## [0.1.0] - 2025-01-16
+
+- Initial release
+[@ivan05almeida]: https://github.com/ivan05almeida

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    easy_changelog (0.1.0)
+    easy_changelog (0.2.0)
 
 GEM
   remote: https://rubygems.org/

data/Rakefile

@@ -13,9 +13,7 @@ require 'rubocop/rake_task'
 
 RuboCop::RakeTask.new
 
-
 path = File.expand_path(__dir__)
 Dir.glob("#{path}/lib/easy_changelog/tasks/**/*.rake").each { |f| import f }
 
-
 task default: %i[test rubocop]

data/lib/easy_changelog/configuration.rb

@@ -1,12 +1,14 @@
 # frozen_string_literal: true
 
 require 'dotenv/load'
+require 'date'
 
 class EasyChangelog
   class Configuration
-    attr_accessor :changelog_filename, :main_branch, :filename_max_length, :include_empty_task_id, :tasks_url
-    attr_reader :entries_path, :unreleased_header, :entry_path_format, :user_signature, :type_mapping
-    attr_writer :repo_url, :tasks_url
+    attr_accessor :changelog_filename, :main_branch, :filename_max_length, :include_empty_task_id, :tasks_url,
+                  :task_id_sanitizer
+    attr_reader :entries_path, :unreleased_header, :entry_path_format, :user_signature, :type_mapping, :task_id_regex
+    attr_writer :repo_url, :release_message_template
 
     def initialize
       @entries_path = 'changelog/'
@@ -14,15 +16,21 @@ class EasyChangelog
 
       @main_branch = 'master'
       @entry_path_format = '<type>_<name>_<timestamp>.md'
-      @unreleased_header = /#{Regexp.escape("## #{@main_branch} (unreleased)")}/m
+      @unreleased_header = /## #{Regexp.escape("#{@main_branch} (unreleased)")}/m
       @user_signature = Regexp.new(format(Regexp.escape('[@%<user>s][]'), user: '([\w-]+)'))
 
       @filename_max_length = 50
-      @type_mapping = { new: 'New features', fix: 'Bug fixes' }
+      @type_mapping = {
+        breaking: { title: 'Breaking Changes', level: :major },
+        new: { title: 'New features', level: :minor },
+        fix: { title: 'Bug fixes', level: :patch }
+      }
       @include_empty_task_id = false
 
       @repo_url = ENV.fetch('REPOSITORY_URL', nil)
       @tasks_url = ENV.fetch('TASKS_URL', nil)
+      @task_id_regex = %r{(?<task_id>[^/]+)/(?:.+)}
+      @release_message_template = -> { "## #{EasyChangelog::VERSION} (#{Date.today.iso8601})" }
     end
 
     def repo_url
@@ -31,8 +39,24 @@ class EasyChangelog
       @repo_url
     end
 
+    def release_message_template
+      raise ConfigurationError, 'release_message_template must be set' unless @release_message_template
+
+      return @release_message_template unless @release_message_template.respond_to?(:call)
+
+      message = @release_message_template.call
+      message = "## #{message}" unless message.start_with?('## ')
+      message
+    end
+
+    def task_id_regex=(value)
+      raise ArgumentError, 'task_id_regex must be a Regexp' unless value.is_a?(Regexp)
+
+      @task_id_regex = value
+    end
+
     def unreleased_header=(value)
-      @unreleased_header = /#{Regexp.escape(value)}/m
+      @unreleased_header = /## #{Regexp.escape(value)}/m
     end
 
     def entries_path=(value)
@@ -57,6 +81,14 @@ class EasyChangelog
       @type_mapping.keys
     end
 
+    def sections
+      @type_mapping.values.map { |v| v[:title] }
+    end
+
+    def section_for(type)
+      @type_mapping[type][:title]
+    end
+
     def entry_path_match_regexp
       formula = @entry_path_format.gsub(/<(\w+)>/) do |match|
         matcher = match == '<type>' ? '[^_]' : '.'

data/lib/easy_changelog/entry.rb

@@ -7,6 +7,8 @@ class EasyChangelog
       id, body = extract_id(body)
       ref_id ||= id || last_commit_id
       ref_type ||= id ? :pull : :commit
+      task_id ||= discover_task_id
+
       super
     end
 
@@ -56,6 +58,15 @@ class EasyChangelog
       `git log -n1 --format="%h"`.chomp
     end
 
+    def discover_task_id
+      return if EasyChangelog.configuration.task_id_regex.nil?
+
+      branch_name = `git rev-parse --abbrev-ref HEAD`
+      return if branch_name == EasyChangelog.configuration.main_branch
+
+      EasyChangelog.configuration.task_id_regex.match(branch_name)&.named_captures&.fetch('task_id', nil)
+    end
+
     def extract_id(body)
       /^\[Fix(?:es)? #(\d+)\] (.*)/.match(body)&.captures || [nil, body]
     end

data/lib/easy_changelog/tasks/changelog.rake

@@ -22,7 +22,7 @@ namespace :changelog do
   task :merge do
     raise 'No entries!' unless EasyChangelog.pending?
 
-    EasyChangelog.new.merge!.and_delete!
+    EasyChangelog.merge_and_delete!
     cmd = "git commit -a -m 'Update Changelog'"
     puts cmd
     sh cmd
@@ -36,4 +36,12 @@ namespace :changelog do
     puts 'Do `bundle exec rake changelog:merge`'
     exit(1)
   end
+
+  desc 'Add release entry'
+  task :release do
+    EasyChangelog.release!
+    cmd = "git commit -a -m 'Update Changelog'"
+    puts cmd
+    sh cmd
+  end
 end

data/lib/easy_changelog/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class EasyChangelog
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/lib/easy_changelog.rb

@@ -11,6 +11,7 @@ class EasyChangelog
 
   class Error < StandardError; end
   class ConfigurationError < StandardError; end
+  class EmptyReleaseError < StandardError; end
 
   require 'easy_changelog/railtie' if defined?(Rails)
 
@@ -27,6 +28,14 @@ class EasyChangelog
       entry_paths.any?
     end
 
+    def merge_and_delete!
+      new.merge_and_delete!
+    end
+
+    def release!
+      new.release!
+    end
+
     def entry_paths
       Dir["#{EasyChangelog.configuration.entries_path}*"]
     end
@@ -36,15 +45,19 @@ class EasyChangelog
     end
   end
 
-  def initialize(content: File.read(EasyChangelog.configuration.changelog_filename), entries: EasyChangelog.read_entries)
+  attr_reader :header, :entries
+
+  def initialize(content: File.read(EasyChangelog.configuration.changelog_filename),
+                 entries: EasyChangelog.read_entries)
     require 'strscan'
 
     parse(content)
     @entries = entries
   end
 
-  def and_delete!
-    @entries.each_key { |path| File.delete(path) }
+  def merge_and_delete!
+    merge!
+    delete!
   end
 
   def merge!
@@ -52,6 +65,15 @@ class EasyChangelog
     self
   end
 
+  def delete!
+    @entries.each_key { |path| File.delete(path) }
+  end
+
+  def release!
+    File.write(EasyChangelog.configuration.changelog_filename, release_content)
+    self
+  end
+
   def unreleased_content
     entry_map = parse_entries(@entries)
     merged_map = merge_entries(entry_map)
@@ -64,7 +86,20 @@ class EasyChangelog
     merged_content << EOF
   end
 
+  def release_content
+    unreleased = unreleased_content
+    raise EmptyReleaseError, 'No unreleased content to release' if unreleased.empty?
+
+    release_message = EasyChangelog.configuration.release_message_template
+    release_message = "\n#{release_message}" unless release_message.start_with?("\n")
+
+    released_content = [@header, release_message, unreleased, @rest.chomp, *new_contributor_lines].join("\n")
+    released_content << EOF
+  end
+
   def new_contributor_lines
+    return [] unless EasyChangelog.configuration.user_signature
+
     unique_contributor_names = contributors.map { |user| format(CONTRIBUTOR, user: user) }.uniq
 
     unique_contributor_names.reject { |line| @rest.include?(line) }
@@ -82,7 +117,7 @@ class EasyChangelog
 
   def merge_entries(entry_map)
     all = @unreleased.merge(entry_map) { |_k, v1, v2| v1.concat(v2) }
-    canonical = EasyChangelog.configuration.type_mapping.values.to_h { |v| [v, nil] }
+    canonical = EasyChangelog.configuration.sections.to_h { |v| [v, nil] }
     canonical.merge(all).compact
   end
 
@@ -90,8 +125,15 @@ class EasyChangelog
     ss = StringScanner.new(content)
 
     @header = ss.scan_until(EasyChangelog.configuration.unreleased_header)
-    @unreleased = parse_release(ss.scan_until(/\n(?=## )/m))
-    @rest = ss.rest
+    unreleased = ss.scan_until(/\n(?=## )/m)
+
+    if unreleased
+      @unreleased = parse_release(unreleased)
+      @rest = ss.rest
+    else
+      @unreleased = parse_release(ss.rest)
+      @rest = ''
+    end
   end
 
   # @return [Hash<type, Array<String>]]
@@ -110,7 +152,7 @@ class EasyChangelog
     changes = Hash.new { |h, k| h[k] = [] }
 
     path_content_map.each do |path, content|
-      header = EasyChangelog.configuration.type_mapping.fetch(entry_type(path))
+      header = EasyChangelog.configuration.section_for(entry_type(path))
 
       changes[header].concat(content.lines.map(&:chomp))
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easy_changelog
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Ivan de Paula Almeida Filho
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-01-17 00:00:00.000000000 Z
+date: 2025-01-22 00:00:00.000000000 Z
 dependencies: []
 description: Changelog generator, based on Rubocop contributing section.
 email: