changelog-builder 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cd667a2329e7e659d7f2636dfd127b1dbe6c07324ef172598ff405996c0b8605
+  data.tar.gz: 83f72939a36976c350205ed601702660ddca22eb7bb8d4af0909b5da6033cfee
+SHA512:
+  metadata.gz: 3813e05cf2b2d48f45a061029f2b0bc8b7ecfc8bbf198d1826359c68c81dca20ec8a15889f9a2c834118cac797e431f60f0e8176829e01672f210dc00067eaa7
+  data.tar.gz: 289416043aac78fd25db488940c09a2b84fec4eceeaaf0437bed48f2c88b07babe14b95fe5143be16207a468ebf2723462aa3c8fa4b4db0b69300e7f5f243691

data/.gitignore

@@ -0,0 +1,23 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea/
+.DS_Store
+
+.graph
+.lorum
+
+# rspec failure tracking
+.rspec_status
+
+.graph
+.lorum
+
+/.github
+
+*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.7
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/.ruby-version

@@ -0,0 +1 @@
+3.4.7

data/.yardopts

@@ -0,0 +1,3 @@
+--title "Changelogger Documentation"
+--output-dir doc
+lib/**/*.rb

data/CHANGELOG.md

@@ -0,0 +1,122 @@
+## [Unreleased]
+
+
+## [0.1.0] - 2021-11-10
+
+- Ignore text files (03fbcb2)
+
+## [0.1.1] - 2021-11-10
+
+- Fix docs for header file (84cefbd)
+
+## [0.1.3] - 2021-12-03
+
+- Reformat files (035f010)
+
+## [0.1.4] - 2021-11-09
+
+- Sample impl of branches window (4fc92e7)
+
+## [0.1.6] - 2021-12-03
+
+- Update .gitignore (41d4f74)
+
+## [0.1.7] - 2021-11-09
+
+- Fix error method in main file (081846c)
+
+## [0.1.9] - 2021-11-10
+
+- Add branches window (5a9f959)
+
+## [0.2.0] - 2021-11-10
+
+- Ignore text files (e12d643)
+
+## [0.2.3] - 2021-11-10
+
+- Fix docs for header file (1c2e935)
+
+## [0.2.5] - 2021-12-03
+
+- Reformat files (03c36b3)
+
+## [0.2.8] - 2021-12-03
+
+- Merge branch 'branch_window' (14a2979)
+
+## [0.3.0] - 2021-12-04
+
+- Edit some code (46457f6)
+
+## [0.3.5] - 2021-12-04
+
+- Update Gemfile.lock (74fbaa6)
+
+## [0.4.0] - 2022-01-16
+
+- Declare 'curses' dependency (f4ddd8e)
+
+## [0.5.0] - 2022-01-16
+
+- Add .ruby-version for development (e91a407)
+
+## [0.6.0] - 2022-01-16
+
+- Add GitHub Actions to .gitignore (4bda768)
+
+## [0.7.0] - 2022-01-16
+
+- Make scrolling work (26ff299)
+
+## [0.7.5] - 2022-01-16
+
+- Add documentation (79684ff)
+
+## [0.8.0] - 2022-02-06
+
+- Adding a skeleton for splitting commits into blocks (6444b24)
+
+## [0.8.5] - 2022-03-01
+
+- :nodocs: (719235a)
+
+## [0.9.0] - 2022-08-17
+
+- Upgraded ruby version (32d3e1a)
+
+## [0.10.0] - 2022-08-17
+
+- Updated `bin/setup` script for development (9f295d9)
+
+## [0.11.0] - 2022-08-17
+
+- Updated `Gemfile.lock` (e0ea39f)
+
+## [0.12.0] - 2022-08-17
+
+- Updated authors list (39f0a12)
+
+## [0.13.0] - 2022-08-17
+
+- Removed `*.gem` binaries from repo (4ecfae0)
+
+## [0.13.5] - 2022-08-17
+
+- Updated `Gemfile.lock` (61cbb94)
+
+## [0.14.0] - 2022-01-16
+
+- Make scrolling work (581af60)
+
+## [0.15.0] - 2022-01-16
+
+- Add documentation (859ca97)
+
+## [0.16.0] - 2022-02-06
+
+- Adding a skeleton for splitting commits into blocks (a81f464)
+
+## [0.17.0] - 2022-03-01
+
+- :nodocs: (71e3e4c)

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 senpaiguru1488@gmail.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,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in changelogger.gemspec
+gemspec
+
+gem "curses"
+gem "rake", "~> 13.0"
+gem "rspec"
+gem "rubocop", require: false
+gem "yard", require: false

data/Gemfile.lock

@@ -0,0 +1,70 @@
+PATH
+  remote: .
+  specs:
+    changelog-builder (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.3)
+    curses (1.5.3)
+    diff-lcs (1.6.2)
+    json (2.15.2)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
+    parallel (1.27.0)
+    parser (3.3.10.0)
+      ast (~> 2.4.1)
+      racc
+    prism (1.6.0)
+    racc (1.8.1)
+    rainbow (3.1.1)
+    rake (13.3.1)
+    regexp_parser (2.11.3)
+    rspec (3.13.2)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.6)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.7)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.6)
+    rubocop (1.81.7)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.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.47.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.47.1)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (3.2.0)
+      unicode-emoji (~> 4.1)
+    unicode-emoji (4.1.0)
+    yard (0.9.37)
+
+PLATFORMS
+  arm64-darwin-25
+  ruby
+
+DEPENDENCIES
+  changelog-builder!
+  curses
+  rake (~> 13.0)
+  rspec
+  rubocop
+  yard
+
+BUNDLED WITH
+   2.7.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 unurgunite
+
+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,204 @@
+# Changelogger
+
+A tiny TUI and CLI to build CHANGELOGs from your git history. Browse your git graph on the left, pick "anchor" commits
+that mark minor releases, and watch a live preview on the right. Press Enter to write CHANGELOG.md. Or, use the
+non-interactive CLI in scripts.
+
+- Left pane: git log graph with htop-style scrolling
+- Right pane: live preview of the generated CHANGELOG
+- Anchor selection -> versions: 0.1.0, 0.2.0, ... with evenly spaced patches in between
+- Colorful highlighting, persistent help bars, comfy terminal UX
+- Headless CLI mode for CI/scripts
+
+Works best on macOS/Linux terminals. Windows users: try WSL.
+
+* [Changelogger](#changelogger)
+    * [Install](#install)
+    * [Usage](#usage)
+        * [Interactive (TUI)](#interactive-tui)
+        * [Non-interactive (CLI for scripts/CI)](#non-interactive-cli-for-scriptsci)
+    * [Versioning algorithm](#versioning-algorithm)
+    * [Output format](#output-format)
+    * [Library (programmatic)](#library-programmatic)
+    * [UI details](#ui-details)
+    * [Requirements](#requirements)
+    * [Troubleshooting](#troubleshooting)
+    * [Contributing](#contributing)
+    * [License](#license)
+
+## Demo
+
+![Demo](docs/demo.gif)
+
+## Install
+
+Gemfile:
+
+```ruby
+gem "changelogger"
+```
+
+Then:
+
+```shell
+bundle install
+```
+
+Or install globally:
+
+```shell
+gem install changelogger
+```
+
+## Usage
+
+### Interactive (TUI)
+
+From a git repository (or pass a repo path/URL):
+
+```shell
+# Current repo
+changelogger
+
+# Local path
+changelogger ../some_dir/project
+
+# GitHub slug
+changelogger rails/rails
+
+# Full URL
+changelogger https://github.com/rails/rails.git
+changelogger git@github.com:rails/rails.git
+```
+
+- Move (left): Up/Down or j/k
+- Select anchors: Space
+- Toggle fit: f (show entire selected commit block if it fits)
+- Refresh graph: r
+- Resize split: < and >
+- Switch focus: Tab / Shift-Tab
+- Scroll preview (right): Up/Down, PgUp/PgDn, g/G
+- Generate: Enter (writes CHANGELOG.md)
+- Quit: q or ESC (exits quietly)
+- z: toggle zebra striping
+- The frame titles show which repo you’re working in:
+    - Left title: `Graph — <repo_name> [<branch>@<short_sha>*]`, where `*` indicates uncommitted changes
+    - Right title: `Preview — <remote slug>` (e.g., owner/repo) or repo name if no remote
+- Visual separators:
+    - A thin dotted line appears at commit boundaries (without overwriting the graph)
+    - Zebra striping per commit block helps scanning; toggle with z
+
+The `.graph` cache is regenerated automatically; use r to refresh.
+
+### Non-interactive (CLI for scripts/CI)
+
+Generate a CHANGELOG without the TUI. You must provide at least 2 anchors (SHAs, tags, or branches). REPO can be a local
+path, GitHub slug, or git URL.
+
+```shell
+# Write CHANGELOG.md in current repo
+changelogger --generate --anchors v1.0.0,v1.1.0
+
+# Write to custom file
+changelogger --generate --anchors abc1234,def5678 -o HISTORY.md
+
+# Run against another repo (local path)
+changelogger --generate --anchors v1.0.0,v1.2.0 ../some/project
+
+# Run against a GitHub repo (slug or URL)
+changelogger --generate --anchors v7.0.0,main rails/rails
+changelogger --generate --anchors a1b2c3d,deadbeef https://github.com/user/repo.git
+
+# Print to stdout (no file)
+changelogger --generate --anchors v1.0.0,v1.1.0 --dry-run
+```
+
+Options:
+
+- `--generate`, `-g`: Non-interactive mode
+- `--anchors x,y,z`: Anchors (2+). Each token can be a full/short SHA, tag, or branch name
+- `--output PATH`, `-o PATH`: Output file (default: CHANGELOG.md)
+- `--major N`: Major version (default 0)
+- `--minor-start N`: Minor start index (default 1 -> 0.1.0, 0.2.0, ...)
+- `--base-patch N`: Patch spacing base (default 10)
+- `--dry-run`: Print to stdout
+
+Exit codes:
+
+- 0: Success
+- 1: General error
+- 2: Invalid arguments (e.g., insufficient anchors)
+
+## Versioning algorithm
+
+"Semantic-ish" mapping:
+
+- Major stays 0 by default (configurable)
+- Minor increments per anchor: 0.1.0, 0.2.0, 0.3.0, ...
+- In-between commits get patches spaced over 1..base (default 10):
+    - `patches[i] = round((i+1) * base / (k+1))` with monotonic fixups
+    - 1 between -> 0.1.5
+    - 2 between -> 0.1.3, 0.1.7
+    - 3 between -> 0.1.3, 0.1.5, 0.1.8
+
+## Output format
+
+Each selected commit (anchors and in-between) gets:
+
+- Section: "## [x.y.z] - YYYY-MM-DD"
+- Bullet: "- <subject> (<short_sha>)"
+- Commit body is included and indented
+- A top "## [Unreleased]" section is always present
+
+## Library (programmatic)
+
+Use the building blocks directly:
+
+```ruby
+require "changelogger"
+# or just require "changelogger"
+
+commits = Changelogger::Git.commits
+anchors = ["abc1234", "def5678"] # full or short SHAs, or resolve with `git rev-parse`
+
+# Preview as a string:
+puts Changelogger::ChangelogGenerator.render(commits, anchors, base_patch: 12)
+
+# Or write:
+Changelogger::ChangelogGenerator.generate(commits, anchors, path: "CHANGELOG.md", major: 1, minor_start: 0)
+```
+
+Note:
+
+- `require "changelogger"` only loads the module/version (no TUI).
+- For the TUI specifically: require "changelogger/tui".
+
+## UI details
+
+- Side-by-side layout with color highlighting
+- Help bars at the top of each pane
+- htop-like scrolling in the graph pane
+- "Fit selected commit" avoids cutting blocks at the bottom (toggle with f)
+- .graph is auto-regenerated; press r to refresh
+
+## Requirements
+
+- Ruby 2.7+
+- Git installed
+- POSIX terminal (colors recommended)
+- Linux/macOS tested; Windows via WSL recommended
+
+## Troubleshooting
+
+- Tab doesn’t switch focus: try Shift-Tab; ensure TERM is set (e.g., xterm-256color)
+- No colors: falls back to bold/standout
+- Not a git repo: pass a repo path/slug/URL
+- Cancel in TUI: exits quietly (no "not enough commits" message)
+
+## Contributing
+
+PRs welcome. Please keep changes focused and include reproduction steps or a short clip for UI tweaks.
+
+## License
+
+MIT © 2021–present unurgunite, SY573M404

data/Rakefile

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+begin
+  require "yard"
+  YARD::Rake::YardocTask.new(:yard) do |t|
+    t.options = File.exist?(".yardopts") ? File.read(".yardopts").split : []
+  end
+rescue LoadError
+  # yard not installed
+end
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "changelogger"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,21 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+PROJECT_NAME='changelogger'
+if pwd | grep $PROJECT_NAME; then
+  cd "${PWD%$PROJECT_NAME*}$PROJECT_NAME"
+else
+  echo "Change your working directory to the $PROJECT_NAME dir or its relative directories. Exiting with error code 1"
+  exit 1
+fi
+
+bundle install
+
+gem build "$PROJECT_NAME".gemspec
+GEM_VERSION=$(bundle info $PROJECT_NAME | head -n 1 | sed 's/.*(\(.*\))/\1/')
+GEM_ARCHIVE="$PROJECT_NAME-$GEM_VERSION.gem"
+gem install "$GEM_ARCHIVE"
+
+bin/console

data/changelogger.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "lib/changelogger/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "changelog-builder"
+  spec.version       = Changelogger::VERSION
+  spec.authors       = %w[unurgunite SY573M404]
+  spec.email         = ["senpaiguru1488@gmail.com", "admin@trolltom.xyz"]
+
+  spec.summary       = "Gem to generate CHANGELOG.md"
+  spec.description   = "A pretty simple gem to easily create changelogs according to your git commit history."
+  spec.homepage      = "https://github.com/unurgunite/changelogger"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.7.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/unurgunite/changelogger"
+  spec.metadata["changelog_uri"] = "https://github.com/unurgunite/changelogger/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(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/exe/changelogger

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "changelogger/cli"
+exit Changelogger::CLI.start(ARGV)