easy_changelog 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 236711ac036de2a58700baeceed154cd1bd88366572c6079035709e21d998704
+  data.tar.gz: 48440bccef6c26da9dab7b7ca2194af70a3f2880eb4bd4d540d5af4ab63161f8
+SHA512:
+  metadata.gz: 41e7ac1c2b79337413818350b4f014ba03e966271538c8b009b867c62509ea8ca16b481c4c34a4b7298e32d2284afb961d82b192ed1308a42cfb0bf87a63f3e6
+  data.tar.gz: de76095801aca8f3c54323d357e980b20657334c632d3333644324b4d1cdb51a5445fb782a5f9f035564aff816c2a445aa994e3e992805f9369b5f0c08e8e40d

data/.env

@@ -0,0 +1 @@
+REPOSITORY_URL = 'https://github.com/ivan05almeida/easy_changelog'

data/.rubocop.yml

@@ -0,0 +1,17 @@
+AllCops:
+  TargetRubyVersion: 2.6
+  NewCops: enable
+
+Style/Documentation:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/.ruby-version

@@ -0,0 +1 @@
+2.7.8

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+## master (unreleased)
+### New features
+
+* [#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][])

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at ivan.filho@avenuecode.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in easy_changelog.gemspec
+gemspec
+
+gem 'dotenv', '~> 2.7'
+gem 'minitest', '~> 5.0'
+gem 'rake', '~> 13.0'
+gem 'rubocop', '~> 1.56'

data/Gemfile.lock

@@ -0,0 +1,50 @@
+PATH
+  remote: .
+  specs:
+    easy_changelog (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    dotenv (2.8.1)
+    json (2.9.1)
+    language_server-protocol (3.17.0.3)
+    minitest (5.25.4)
+    parallel (1.26.3)
+    parser (3.3.7.0)
+      ast (~> 2.4.1)
+      racc
+    racc (1.8.1)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    regexp_parser (2.10.0)
+    rubocop (1.70.0)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.36.2, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.37.0)
+      parser (>= 3.3.1.0)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
+
+PLATFORMS
+  x86_64-darwin-20
+
+DEPENDENCIES
+  dotenv (~> 2.7)
+  easy_changelog!
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  rubocop (~> 1.56)
+
+BUNDLED WITH
+   2.3.25

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Ivan de Paula Almeida Filho
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,88 @@
+# EasyChangelog
+
+<strong>EasyChangelog</strong> is a tool easily manage your project changelog. This project is based on Rubocop changelog style with more customizations to your needs.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add easy_changelog
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install easy_changelog
+
+## Usage
+
+### Configuration
+
+Write an easy_changelog.rb at the initiliazers folder in order to config the gem accordingly to your project
+
+```ruby
+EasyChangelog.configure do |config|
+    config.entries_path = 'changelog/'                      # the folder where the changelog entries will be stored
+    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.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
+
+    config.type_mapping = {                                 # Entry types and their Section Names to be displayed at Changelog
+        new: 'New features',
+        fix: 'Bug fixes'
+    }
+
+    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)
+end
+```
+
+### Entries Types
+
+By default this gem supports new and fix changelog entries. Check the Configuration section to see how you can change this with type_mapping option.
+
+For each supported type, you can call their rake task:
+
+```
+$ bundle exec rake changelog:new -- --ref-id=1234 --ref-type=pull
+```
+
+To know all options available you can add `--help` option to the command
+
+By default if a ref id is given the ref-type default will be pull, if it's blank it will be commit and the changelog will then contain reference with the short git commit ID instead.
+
+You can still pass a ref-id and set ref-type to issues to add a reference to a issue card
+
+### Prepare changelog to deployment/release
+
+To add the entries to your changelog just need to run
+
+```
+$ bundle exec rake changelog:merge
+```
+
+If you want to check if there are entries to merge:
+```
+$ bundle exec rake changelog:check_clean
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/easy_changelog. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/easy_changelog/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Ruby::Changelog project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/easy_changelog/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/test_*.rb']
+end
+
+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/easy-changelog.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative 'lib/easy_changelog/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'easy_changelog'
+  spec.version = EasyChangelog::VERSION
+  spec.authors = ['Ivan de Paula Almeida Filho']
+  spec.email = ['ivan05filho@gmail.com']
+
+  spec.summary = 'Small tool to generate a changelog file based on git commits.'
+  spec.description = 'Changelog generator, based on Rubocop contributing section.'
+  spec.homepage = 'https://github.com/ivan05almeida/easy_changelog'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 2.6.0'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = "#{spec.homepage}/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+  spec.metadata['rubygems_mfa_required'] = 'true'
+end

data/lib/easy_changelog/configuration.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require 'dotenv/load'
+
+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
+
+    def initialize
+      @entries_path = 'changelog/'
+      @changelog_filename = 'CHANGELOG.md'
+
+      @main_branch = 'master'
+      @entry_path_format = '<type>_<name>_<timestamp>.md'
+      @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' }
+      @include_empty_task_id = false
+
+      @repo_url = ENV.fetch('REPOSITORY_URL', nil)
+      @tasks_url = ENV.fetch('TASKS_URL', nil)
+    end
+
+    def repo_url
+      raise ConfigurationError, 'repo_url must be set' unless @repo_url
+
+      @repo_url
+    end
+
+    def unreleased_header=(value)
+      @unreleased_header = /#{Regexp.escape(value)}/m
+    end
+
+    def entries_path=(value)
+      value += '/' unless value.end_with?('/')
+
+      @entries_path = value
+    end
+
+    def type_mapping=(value)
+      raise ArgumentError, 'type_mapping must be a Hash' unless value.is_a?(Hash)
+
+      @type_mapping = value
+    end
+
+    def user_signature=(value)
+      raise ArgumentError, 'user_signature must be a Regexp' unless value.is_a?(Regexp)
+
+      @user_signature = value
+    end
+
+    def changelog_types
+      @type_mapping.keys
+    end
+
+    def entry_path_match_regexp
+      formula = @entry_path_format.gsub(/<(\w+)>/) do |match|
+        matcher = match == '<type>' ? '[^_]' : '.'
+        "(?#{match}#{matcher}+)"
+      end
+
+      Regexp.new("(?:#{entries_path})?#{formula}")
+    end
+
+    def entry_path_template
+      File.join(entries_path, @entry_path_format.gsub(/<(\w+)>/) { |_match| "%<#{Regexp.last_match(1)}>s" })
+    end
+  end
+end

data/lib/easy_changelog/entry.rb

@@ -0,0 +1,98 @@
+# 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)
+      ref_id ||= id || last_commit_id
+      ref_type ||= id ? :pull : :commit
+      super
+    end
+
+    def write
+      dir_name = EasyChangelog.configuration.entries_path
+      FileUtils.mkdir_p(dir_name) unless File.directory?(dir_name)
+
+      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')
+      )
+    end
+
+    def content
+      title = body.dup
+      title += '.' unless title.end_with? '.'
+
+      "* #{ref}: #{task_ref} #{title} ([@#{user}][])\n"
+    end
+
+    def ref
+      raise ArgumentError, 'ref_type must be issues, pull, or commit' unless %w[issues pull commit].include?(ref_type)
+
+      "[##{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?
+
+      link = "[#{task_id}]"
+      base_url = tasks_url || EasyChangelog.configuration.tasks_url
+      link += "(#{base_url}/#{task_id})" if base_url
+
+      link
+    end
+
+    def last_commit_title
+      `git log -1 --pretty=%B`.lines.first.chomp
+    end
+
+    def last_commit_id
+      `git log -n1 --format="%h"`.chomp
+    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/railtie.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'easy_changelog'
+require 'rails'
+
+class EasyChangelog
+  class Railtie < Rails::Railtie
+    railtie_name :easy_changelog
+
+    rake_tasks do
+      load 'tasks/changelog.rake'
+    end
+  end
+end

data/lib/easy_changelog/task_options_parser.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'optparse'
+
+class EasyChangelog
+  class TaskOptionsParser
+    def self.parse(type, args)
+      options = {}
+      opts = OptionParser.new
+      args = opts.order!(args) {}
+
+      opts.banner = "Usage: rake changelog:#{type} [options]"
+
+      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('-h', '--help', 'Prints this helper') do
+        puts opts
+        exit
+      end
+
+      opts.parse!(args)
+
+      options
+    end
+  end
+end

data/lib/easy_changelog/tasks/changelog.rake

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'easy_changelog'
+require 'easy_changelog/task_options_parser'
+
+namespace :changelog do
+  EasyChangelog.configuration.changelog_types.each do |type|
+    desc "Create a Changelog entry (#{type})"
+    task type do
+      options = EasyChangelog::TaskOptionsParser.parse(type, ARGV)
+      options[:type] = type
+
+      entry = EasyChangelog::Entry.new(**options)
+      path = entry.write
+      cmd = "git add #{path}"
+      sh cmd
+      puts "Entry '#{path}' created and added to git index"
+    end
+  end
+
+  desc 'Merge entries and delete them'
+  task :merge do
+    raise 'No entries!' unless EasyChangelog.pending?
+
+    EasyChangelog.new.merge!.and_delete!
+    cmd = "git commit -a -m 'Update Changelog'"
+    puts cmd
+    sh cmd
+  end
+
+  desc 'Check for no pending changelog entries'
+  task :check_clean do
+    next unless EasyChangelog.pending?
+
+    puts '*** Pending changelog entries!'
+    puts 'Do `bundle exec rake changelog:merge`'
+    exit(1)
+  end
+end

data/lib/easy_changelog/version.rb

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

data/lib/easy_changelog.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+require 'easy_changelog/version'
+require 'easy_changelog/configuration'
+require 'easy_changelog/entry'
+
+class EasyChangelog
+  HEADER = /### (.*)/.freeze
+  CONTRIBUTOR = '[@%<user>s]: https://github.com/%<user>s'
+  EOF = "\n"
+
+  class Error < StandardError; end
+  class ConfigurationError < StandardError; end
+
+  require 'easy_changelog/railtie' if defined?(Rails)
+
+  class << self
+    def configuration
+      @configuration ||= EasyChangelog::Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+    def pending?
+      entry_paths.any?
+    end
+
+    def entry_paths
+      Dir["#{EasyChangelog.configuration.entries_path}*"]
+    end
+
+    def read_entries
+      entry_paths.to_h { |path| [path, File.read(path)] }
+    end
+  end
+
+  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) }
+  end
+
+  def merge!
+    File.write(EasyChangelog.configuration.changelog_filename, merge_content)
+    self
+  end
+
+  def unreleased_content
+    entry_map = parse_entries(@entries)
+    merged_map = merge_entries(entry_map)
+    merged_map.flat_map { |header, things| ["### #{header}\n", *things, ''] }.join("\n")
+  end
+
+  def merge_content
+    merged_content = [@header, unreleased_content, @rest.chomp, *new_contributor_lines].join("\n")
+
+    merged_content << EOF
+  end
+
+  def new_contributor_lines
+    unique_contributor_names = contributors.map { |user| format(CONTRIBUTOR, user: user) }.uniq
+
+    unique_contributor_names.reject { |line| @rest.include?(line) }
+  end
+
+  def contributors
+    contributors = @entries.values.flat_map do |entry|
+      entry.match(/\. \((?<contributors>.+)\)\n/)[:contributors].split(',')
+    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) }
+    canonical = EasyChangelog.configuration.type_mapping.values.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 = parse_release(ss.scan_until(/\n(?=## )/m))
+    @rest = ss.rest
+  end
+
+  # @return [Hash<type, Array<String>]]
+  def parse_release(unreleased)
+    unreleased
+      .lines
+      .map(&:chomp)
+      .reject(&:empty?)
+      .slice_before(HEADER)
+      .to_h do |header, *entries|
+        [HEADER.match(header)[1], entries]
+      end
+  end
+
+  def parse_entries(path_content_map)
+    changes = Hash.new { |h, k| h[k] = [] }
+
+    path_content_map.each do |path, content|
+      header = EasyChangelog.configuration.type_mapping.fetch(entry_type(path))
+
+      changes[header].concat(content.lines.map(&:chomp))
+    end
+
+    changes
+  end
+
+  def entry_type(path)
+    EasyChangelog.configuration.entry_path_match_regexp.match(path)[:type].to_sym
+  end
+end

data/sig/easy_changelog.rbs

@@ -0,0 +1,4 @@
+module RubyChangelog
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: easy_changelog
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ivan de Paula Almeida Filho
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-01-17 00:00:00.000000000 Z
+dependencies: []
+description: Changelog generator, based on Rubocop contributing section.
+email:
+- ivan05filho@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env"
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- easy-changelog.gemspec
+- lib/easy_changelog.rb
+- lib/easy_changelog/configuration.rb
+- lib/easy_changelog/entry.rb
+- lib/easy_changelog/railtie.rb
+- lib/easy_changelog/task_options_parser.rb
+- lib/easy_changelog/tasks/changelog.rake
+- lib/easy_changelog/version.rb
+- sig/easy_changelog.rbs
+homepage: https://github.com/ivan05almeida/easy_changelog
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ivan05almeida/easy_changelog
+  source_code_uri: https://github.com/ivan05almeida/easy_changelog
+  changelog_uri: https://github.com/ivan05almeida/easy_changelog/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Small tool to generate a changelog file based on git commits.
+test_files: []