easy_changelog 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5abde6f38f9a3543628e9e6d44f0557b3a846449003ef0f14eb2638bba401487
-  data.tar.gz: 772c7cfd1b3c70990d854f5cb7f397806378127a8daff4002923b44725350d40
+  metadata.gz: 8daff142414ebf8420379e1f0536b020a9852080ecd517981d9766c5644054a7
+  data.tar.gz: 6f0c1a26f4aa96a987104b3e0feb5b72127acb996600cad537fc7a963231f741
 SHA512:
-  metadata.gz: c12f08de909626229dabfd798f42419563e813b7dac6dfae2d5222863b12c8940f3fdeb525d211581ed8b24282d203f4927b70de0443c5e873f99a172e03f7bf
-  data.tar.gz: fa9fcd2985d1472dd6186aed6d582c4fbe588d2c798887004b216932ab73b1d43f3d46cf0af4b0980b470dd3c7358c92041f62540bf3e6cb793f0c9d01189320
+  metadata.gz: a3ead37ca521e143ad9b382a033e5521100094713a5712a8044902af2e7652478e74984927b02c4e217351ad39a3d1410bf7714d28919cdf1de2d09f4917659f
+  data.tar.gz: b8ab8c7b836dc92fe6d30b1e03927bd40029d4b298cea9667768d43be4838813309b15ce7af2602beaea13f42bf9962e981cffc999531815ab4eeda0748067f2

data/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## master (unreleased)
 
+## 1.2.0 (2025-02-06)
+### New features
+
+* [#935a524](https://github.com/ivan05almeida/easy_changelog/commit/935a524):  Add more customizations. (ivan05almeida)
+
 ## 1.1.0 (2025-01-23)
 ### New features
 

data/Gemfile.lock

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

data/README.md

@@ -24,7 +24,7 @@ EasyChangelog.configure do |config|
     config.changelog_filename = 'CHANGELOG.md'              # the filename of your changelog
     config.main_branch = 'master'                           # main branch for repository
     config.filename_max_length = 50                         # max filename length
-    config.include_empty_task_id = false                    # includes a [] when task id and the project still need to track tasks without tickets
+    config.include_empty_card_id = false                    # includes a [] when task id and the project still need to track tasks without tickets
 
     config.unreleased_header = '## master (unreleased)'     # Header of changelog where the unreleased entries are located
     config.user_signature = /\[@([\w-]+)\]\[\]/             # Regexp to list unique contributors of the project
@@ -35,7 +35,7 @@ EasyChangelog.configure do |config|
     }
 
     config.repo_url = <GITHUB_REPO_URL>                     # URL to your repository (Can also be defined with REPOSITORY_URL var var)
-    config.tasks_url = <YOUR_ISSUE_TRACKING_URL>            # URL to your organization issue tracker (ex: JIRA, Asana, Wrike. Can also be defined with REPOSITORY_URL env var)
+    config.cards_url = <YOUR_ISSUE_TRACKING_URL>            # URL to your organization issue tracker (ex: JIRA, Asana, Wrike. Can also be defined with REPOSITORY_URL env var)
 end
 ```
 

data/lib/easy_changelog/configuration.rb

@@ -5,23 +5,28 @@ require 'date'
 
 class EasyChangelog
   class Configuration
-    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_accessor :changelog_filename, :main_branch, :filename_max_length, :include_empty_card_id, :cards_url,
+                  :entry_row_format
+    attr_reader :entries_path, :unreleased_header, :entry_path_format, :user_signature, :type_mapping, :card_id_regex,
+                :entries_order, :card_id_normalizer
+
     attr_writer :repo_url, :release_message_template
 
-    CONFIG_PATHS = %w(
+    CONFIG_PATHS = %w[
       ./.easy_changelog.rb
       ./config/initializers/easy_changelog.rb
       ./config/easy_changelog.rb
-    )
+    ].freeze
 
+    # rubocop:disable Metrics/AbcSize
     def initialize
       @entries_path = 'changelog/'
+      @entries_order = :asc
       @changelog_filename = 'CHANGELOG.md'
 
       @main_branch = 'master'
       @entry_path_format = '<type>_<name>_<timestamp>.md'
+      @entry_row_format = '* <ref>: <card_ref> <title> (<username>)'
       @unreleased_header = /## #{Regexp.escape("#{@main_branch} (unreleased)")}/m
       @user_signature = Regexp.new(format(Regexp.escape('[@%<user>s][]'), user: '([\w-]+)'))
 
@@ -31,13 +36,14 @@ class EasyChangelog
         feature: { title: 'New features', level: :minor },
         fix: { title: 'Bug fixes', level: :patch }
       }
-      @include_empty_task_id = false
+      @include_empty_card_id = false
 
       @repo_url = ENV.fetch('REPOSITORY_URL', nil)
-      @tasks_url = ENV.fetch('TASKS_URL', nil)
-      @task_id_regex = %r{(?<task_id>[^/]+)/(?:.+)}
+      @cards_url = ENV.fetch('CARDS_URL', nil)
+      @card_id_regex = %r{(?<card_id>[^/]+)/(?:.+)}
       @release_message_template = -> { "## #{EasyChangelog::VERSION} (#{Date.today.iso8601})" }
     end
+    # rubocop:enable Metrics/AbcSize
 
     def repo_url
       raise ConfigurationError, 'repo_url must be set' unless @repo_url
@@ -55,10 +61,16 @@ class EasyChangelog
       message
     end
 
-    def task_id_regex=(value)
-      raise ArgumentError, 'task_id_regex must be a Regexp' unless value.is_a?(Regexp)
+    def card_regex=(value)
+      raise ArgumentError, 'card_regex must be a Regexp' unless value.is_a?(Regexp)
+
+      @card_regex = value
+    end
+
+    def card_id_normalizer=(value)
+      raise ArgumentError, 'card_id_normalizer must be callable' unless value.respond_to?(:call)
 
-      @task_id_regex = value
+      @card_id_normalizer = value
     end
 
     def unreleased_header=(value)
@@ -71,6 +83,13 @@ class EasyChangelog
       @entries_path = value
     end
 
+    def entries_order=(value)
+      value = value.to_sym
+      raise ArgumentError, 'entries_order must be :asc or :desc' unless %i[asc desc].include?(value)
+
+      @entries_order = value
+    end
+
     def type_mapping=(value)
       raise ArgumentError, 'type_mapping must be a Hash or :loose' unless value.is_a?(Hash) || value == :loose
 
@@ -99,12 +118,6 @@ class EasyChangelog
       @type_mapping.values.map { |v| v[:title] }
     end
 
-    def section_for(type)
-      return '' if @type_mapping == :loose
-
-      @type_mapping[type][:title]
-    end
-
     def entry_path_match_regexp
       formula = @entry_path_format.gsub(/<(\w+)>/) do |match|
         matcher = match == '<type>' ? '[^_]' : '.'
@@ -118,9 +131,20 @@ class EasyChangelog
       File.join(entries_path, @entry_path_format.gsub(/<(\w+)>/) { |_match| "%<#{Regexp.last_match(1)}>s" })
     end
 
+    def entry_row_match_regexp
+      with_optional_card_ref = Regexp.escape(@entry_row_format).gsub('<card_ref>\\ ') { |match| "(?:#{match})?" }
+      formula = with_optional_card_ref.gsub(/<(\w+)>/) { |match| "(?#{match}.+)" }
+
+      Regexp.new(formula)
+    end
+
+    def entry_row_template
+      @entry_row_format.gsub(/<(\w+)>/) { |_match| "%<#{Regexp.last_match(1)}>s" }
+    end
+
     def load_config
-      paths = CONFIG_PATHS.map { |path| File.expand_path(path) }
-      path = paths.select { |path| File.exist?(path) }.first
+      paths = CONFIG_PATHS.map { |file_path| File.expand_path(file_path) }
+      path = paths.select { |file_path| File.exist?(file_path) }.first
 
       return unless path
 

data/lib/easy_changelog/entry.rb

@@ -1,37 +1,38 @@
 # frozen_string_literal: true
 
 class EasyChangelog
-  Entry = Struct.new(:type, :body, :ref_type, :ref_id, :task_id, :tasks_url, :user, keyword_init: true) do
-    def initialize(type:, body: last_commit_title, ref_type: nil, ref_id: nil, task_id: nil, tasks_url: nil,
-                   user: github_user)
-      id, body = extract_id(body)
+  Entry = Struct.new(:type, :body, :ref_type, :ref_id, :card_id, :cards_url, :branch_name, :user, keyword_init: true) do
+    def initialize(type:, body: last_commit_title, ref_type: nil, ref_id: nil, card_id: nil, cards_url: nil,
+                   user: github_user, branch_name: nil)
+      id, body = EasyChangelog::Utility.extract_id(body)
       ref_id ||= id || last_commit_id
       ref_type ||= id ? :pull : :commit
-      task_id ||= discover_task_id
+      card_id ||= EasyChangelog::Utility.discover_card_id(branch_name)
 
       super
     end
 
     def write
-      dir_name = EasyChangelog.configuration.entries_path
-      FileUtils.mkdir_p(dir_name) unless File.directory?(dir_name)
+      EasyChangelog::Utility.ensure_entries_dir_exists
 
       File.write(path, content)
       path
     end
 
     def path
-      format(
-        EasyChangelog.configuration.entry_path_template,
-        type: type, name: str_to_filename(body), timestamp: Time.now.strftime('%Y%m%d%H%M%S')
-      )
+      filename = EasyChangelog::Utility.str_to_filename(body)
+      options = { type: type, name: filename, timestamp: Time.now.strftime('%Y%m%d%H%M%S') }
+
+      format(EasyChangelog.configuration.entry_path_template, options)
     end
 
     def content
       title = body.dup
       title += '.' unless title.end_with? '.'
 
-      "* #{ref}: #{task_ref} #{title} ([@#{user}][])\n"
+      options = { ref: ref, card_ref: card_ref, title: title, username: user }
+
+      format(EasyChangelog.configuration.entry_row_template, options)
     end
 
     def ref
@@ -40,12 +41,12 @@ class EasyChangelog
       "[##{ref_id}](#{EasyChangelog.configuration.repo_url}/#{ref_type}/#{ref_id})"
     end
 
-    def task_ref
-      return EasyChangelog.configuration.include_empty_task_id ? '[] ' : '' if task_id.nil? || task_id.empty?
+    def card_ref
+      return EasyChangelog.configuration.include_empty_card_id ? '[] ' : '' if card_id.nil? || card_id.empty?
 
-      link = "[#{task_id}]"
-      base_url = tasks_url || EasyChangelog.configuration.tasks_url
-      link += "(#{base_url}/#{task_id})" if base_url
+      link = "[#{card_id}]"
+      base_url = cards_url || EasyChangelog.configuration.cards_url
+      link += "(#{base_url}/#{card_id})" if base_url
 
       link
     end
@@ -58,52 +59,11 @@ 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
-
-    def str_to_filename(str)
-      str
-        .split
-        .reject(&:empty?)
-        .map { |s| prettify(s) }
-        .inject do |result, word|
-          s = "#{result}_#{word}"
-          return result if s.length > EasyChangelog.configuration.filename_max_length
-
-          s
-        end
-    end
-
     def github_user
       user = `git config --global credential.username`.chomp
       warn 'Set your username with `git config --global credential.username "myusernamehere"`' if user.empty?
 
       user
     end
-
-    private
-
-    def prettify(str)
-      str.gsub!(/\W/, '_')
-
-      # Separate word boundaries by `_`.
-      str.gsub!(/([A-Z]+)(?=[A-Z][a-z])|([a-z\d])(?=[A-Z])/) do
-        (Regexp.last_match(1) || Regexp.last_match(2)) << '_'
-      end
-
-      str.gsub!(/\A_+|_+\z/, '')
-      str.downcase!
-      str
-    end
   end
 end

data/lib/easy_changelog/task_options_parser.rb

@@ -12,11 +12,12 @@ class EasyChangelog
       opts.banner = "Usage: rake changelog:#{type} [options]"
 
       opts.on('-u', '--user=ARG', 'Git Username') { |arg| options[:user] = arg }
-      opts.on('-b', '--body=ARG', 'Changelog Body Entry') { |arg| options[:body] = arg }
+      opts.on('-b', '--branch=ARG', 'Branch Name') { |arg| options[:branch_name] = arg }
+      opts.on('-t', '--title=ARG', 'Changelog Title Entry') { |arg| options[:body] = arg }
       opts.on('-r', '--ref-id=ARG', 'Ref ID') { |arg| options[:ref_id] = arg }
       opts.on('-R', '--ref-type=ARG', 'Ref type (issues|pull|commit)') { |arg| options[:ref_type] = arg }
-      opts.on('-t', '--task-id=ARG', 'Task ID') { |arg| options[:task_id] = arg }
-      opts.on('-T', '--task-url=ARG', 'Tasks URL') { |arg| options[:tasks_url] = arg }
+      opts.on('-c', '--card-id=ARG', 'Card ID') { |arg| options[:card_id] = arg }
+      opts.on('-C', '--cards-url=ARG', 'Cards base URL') { |arg| options[:cards_url] = arg }
 
       opts.on('-h', '--help', 'Prints this helper') do
         puts opts

data/lib/easy_changelog/utility.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+class EasyChangelog
+  class Utility
+    class << self
+      def ensure_entries_dir_exists
+        dir_name = EasyChangelog.configuration.entries_path
+        FileUtils.mkdir_p(dir_name) unless File.directory?(dir_name)
+      end
+
+      # rubocop:disable Metrics/MethodLength
+      def parse_changelog(content)
+        ss = StringScanner.new(content)
+
+        header = ss.scan_until(EasyChangelog.configuration.unreleased_header)
+        unreleased = ss.scan_until(/\n(?=## )/m)
+
+        if unreleased.nil?
+          unreleased = parse_unreleased_entries(ss.rest)
+          rest = ''
+        else
+          unreleased = parse_unreleased_entries(unreleased)
+          rest = ss.rest
+        end
+
+        [header, unreleased, rest]
+      end
+      # rubocop:enable Metrics/MethodLength
+
+      def update_changelog(content)
+        File.write(EasyChangelog.configuration.changelog_filename, content)
+      end
+
+      def attr_from_path(var_name, path)
+        EasyChangelog.configuration.entry_path_match_regexp.match(path)[var_name.to_sym]
+      end
+
+      def attr_from_entry(var_name, entry)
+        EasyChangelog.configuration.entry_row_match_regexp.match(entry)[var_name.to_sym]
+      end
+
+      def section_for(path)
+        entry_type = attr_from_path(:type, path).to_sym
+
+        return '' if EasyChangelog.configuration.loose?
+
+        EasyChangelog.configuration.type_mapping[entry_type][:title]
+      end
+
+      def discover_card_id(branch_name)
+        return if EasyChangelog.configuration.card_id_regex.nil?
+
+        branch_name ||= `git rev-parse --abbrev-ref HEAD`
+        return if branch_name == EasyChangelog.configuration.main_branch
+
+        id = EasyChangelog.configuration.card_id_regex.match(branch_name)&.named_captures&.fetch('card_id', nil)
+
+        normalize_card_id(id)
+      end
+
+      def extract_id(body)
+        /^\[Fix(?:es)? #(\d+)\] (.*)/.match(body)&.captures || [nil, body]
+      end
+
+      def str_to_filename(str)
+        str
+          .split
+          .reject(&:empty?)
+          .map { |s| prettify(s) }
+          .inject do |result, word|
+            s = "#{result}_#{word}"
+            return result if s.length > EasyChangelog.configuration.filename_max_length
+
+            s
+          end
+      end
+
+      private
+
+      def normalize_card_id(id)
+        return id unless EasyChangelog.configuration.card_id_normalizer
+
+        EasyChangelog.configuration.card_id_normalizer.call(id)
+      end
+
+      # @return [Hash<type, Array<String>]]
+      def parse_unreleased_entries(unreleased)
+        entries = unreleased.lines.map(&:chomp).reject(&:empty?)
+
+        return { '' => entries } if EasyChangelog.configuration.loose?
+
+        entries.slice_before(HEADER).to_h { |header, *header_entries| [HEADER.match(header)[1], header_entries] }
+      end
+
+      def prettify(str)
+        str.gsub!(/\W/, '_')
+
+        # Separate word boundaries by `_`.
+        str.gsub!(/([A-Z]+)(?=[A-Z][a-z])|([a-z\d])(?=[A-Z])/) do
+          (Regexp.last_match(1) || Regexp.last_match(2)) << '_'
+        end
+
+        str.gsub!(/\A_+|_+\z/, '')
+        str.downcase!
+        str
+      end
+    end
+  end
+end

data/lib/easy_changelog/version.rb

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

data/lib/easy_changelog.rb

@@ -2,6 +2,7 @@
 
 require 'easy_changelog/version'
 require 'easy_changelog/configuration'
+require 'easy_changelog/utility'
 require 'easy_changelog/entry'
 
 class EasyChangelog
@@ -55,7 +56,7 @@ class EasyChangelog
                  entries: EasyChangelog.read_entries)
     require 'strscan'
 
-    parse(content)
+    @header, @unreleased, @rest = EasyChangelog::Utility.parse_changelog(content)
     @entries = entries
   end
 
@@ -65,7 +66,7 @@ class EasyChangelog
   end
 
   def merge!
-    File.write(EasyChangelog.configuration.changelog_filename, merge_content)
+    EasyChangelog::Utility.update_changelog(merge_content)
     self
   end
 
@@ -74,7 +75,7 @@ class EasyChangelog
   end
 
   def release!
-    File.write(EasyChangelog.configuration.changelog_filename, release_content)
+    EasyChangelog::Utility.update_changelog(release_content)
     self
   end
 
@@ -116,50 +117,26 @@ class EasyChangelog
   end
 
   def contributors
-    contributors = @entries.values.flat_map do |entry|
-      entry.match(/\. \((?<contributors>.+)\)\n/)[:contributors].split(',')
+    @entries.values.flat_map do |entry|
+      EasyChangelog::Utility.attr_from_entry(:username, entry)&.gsub(/@/, '')
     end
-
-    contributors.join.scan(EasyChangelog.configuration.user_signature).flatten
   end
 
   private
 
   def merge_entries(entry_map)
-    all = @unreleased.merge(entry_map) { |_k, v1, v2| v1.concat(v2) }
+    all = @unreleased.merge(entry_map) do |_k, v1, v2|
+      EasyChangelog.configuration.entries_order == :desc ? v2.concat(v1) : v1.concat(v2)
+    end
     canonical = EasyChangelog.configuration.sections.to_h { |v| [v, nil] }
     canonical.merge(all).compact
   end
 
-  def parse(content)
-    ss = StringScanner.new(content)
-
-    @header = ss.scan_until(EasyChangelog.configuration.unreleased_header)
-    unreleased = ss.scan_until(/\n(?=## )/m)
-
-    if unreleased.nil?
-      @unreleased = parse_release(ss.rest)
-      @rest = ''
-    else
-      @unreleased = parse_release(unreleased)
-      @rest = ss.rest
-    end
-  end
-
-  # @return [Hash<type, Array<String>]]
-  def parse_release(unreleased)
-    entries = unreleased.lines.map(&:chomp).reject(&:empty?)
-
-    return { '' => entries } if EasyChangelog.configuration.loose?
-
-    entries.slice_before(HEADER).to_h { |header, *header_entries| [HEADER.match(header)[1], header_entries] }
-  end
-
   def parse_entries(path_content_map)
     changes = Hash.new { |h, k| h[k] = [] }
 
-    path_content_map.each do |path, content|
-      header = EasyChangelog.configuration.section_for(entry_type(path))
+    sorted_entries(path_content_map).each do |path, content|
+      header = EasyChangelog::Utility.section_for(path)
 
       changes[header].concat(content.lines.map(&:chomp))
     end
@@ -167,7 +144,10 @@ class EasyChangelog
     changes
   end
 
-  def entry_type(path)
-    EasyChangelog.configuration.entry_path_match_regexp.match(path)[:type].to_sym
+  def sorted_entries(path_content_map)
+    sorted = path_content_map.sort_by { |path, _content| EasyChangelog::Utility.attr_from_path(:timestamp, path) }
+    sorted = sorted.reverse if EasyChangelog.configuration.entries_order == :desc
+
+    sorted
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easy_changelog
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Ivan de Paula Almeida Filho
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-01-23 00:00:00.000000000 Z
+date: 2025-02-06 00:00:00.000000000 Z
 dependencies: []
 description: Changelog generator, based on Rubocop contributing section.
 email:
@@ -34,6 +34,7 @@ files:
 - lib/easy_changelog/railtie.rb
 - lib/easy_changelog/task_options_parser.rb
 - lib/easy_changelog/tasks/changelog.rake
+- lib/easy_changelog/utility.rb
 - lib/easy_changelog/version.rb
 - sig/easy_changelog.rbs
 homepage: https://github.com/ivan05almeida/easy_changelog