glyptodont 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3cfa9e6366161885c86dbe07e79c0c14d57a58bbdf8c7e69d3683b6d96838dfe
-  data.tar.gz: d71c6335cd02094e9bbabc72701c21e7cb6001617a2eddbb5884f68d496dff43
+  metadata.gz: b0bdb41b7c944725ff0cc501c8ee3b64d77fd8aa5cee211d1697ce43fe8547d1
+  data.tar.gz: 5d1a40a6f07b45b89487775ffad5d92ce3a84982ee19db732d13b8066e56ca68
 SHA512:
-  metadata.gz: 994f96b328e5beef3093bb344ec53f362c3fa2255da24338343069b9511fafd0be2999ecd8a5e60a43bb55966e8e155061ef43a1b0dca5acdf180b7f857bffa5
-  data.tar.gz: 1e8200f3b8cce054163ba12d9e31a87267f12ea3c0796cb47809c7abf5d66f7603cd0fefb59cc6cfca1e7ffd5b2a533a0e080be15012b9223a081af8517ca2f7
+  metadata.gz: efdfeb5ca64d4c3f41b6320b7d7de4df52d02cc5dd68bf223c036c769c8b8477240e2b57336de69cbdbe8878cda22d7b3dfe56b6fe826d143f2342d11a9deb38
+  data.tar.gz: 3672461a3f02c7572bae1289e4db373efde349a1d00ff34ee94cd142efbd1c8accdf3df4622e324395d70af9ee9b5136aba2d31e613f772664f7ca8b8f7812a9

data/.githooks/commit-msg

@@ -0,0 +1,29 @@
+#!/bin/sh
+# Validate conventional commit message format.
+# See https://www.conventionalcommits.org/
+
+set -e
+
+msg_file="$1"
+if [ ! -f "$msg_file" ]; then
+  echo "commit-msg: no message file" >&2
+  exit 1
+fi
+
+first_line=$(head -n 1 "$msg_file")
+
+# Allow merge and revert commits
+case "$first_line" in
+  Merge\ *) exit 0 ;;
+  Revert\ *) exit 0 ;;
+esac
+
+# Conventional: type(scope)?!?: description
+# Types: feat, fix, docs, style, refactor, perf, test, build, ci, chore
+if echo "$first_line" | grep -qE '^(feat|fix|docs|style|refactor|perf|test|build|ci|chore)(\([a-zA-Z0-9_.-]+\))?!?: .+'; then
+  exit 0
+fi
+
+echo "commit-msg: commit message must follow Conventional Commits (e.g. feat: add X, fix: resolve Y)." >&2
+echo "  First line: $first_line" >&2
+exit 1

data/.githooks/pre-commit

@@ -0,0 +1,13 @@
+#!/bin/sh
+# Run project checks before allowing a commit.
+# Requires Mise and script/test (RuboCop + RSpec).
+
+set -e
+
+cd "$(git rev-parse --show-toplevel)"
+
+if [ -f ".tool-versions" ] && command -v mise >/dev/null 2>&1; then
+  mise exec -- ./script/test
+else
+  ./script/test
+fi

data/.github/conventional-commits-since

@@ -0,0 +1 @@
+ffd9343

data/.github/dependabot.yml

@@ -0,0 +1,17 @@
+# https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+
+version: 2
+updates:
+  - package-ecosystem: "bundler"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    commit-message:
+      prefix: "deps"
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    commit-message:
+      prefix: "ci"

data/.github/workflows/dependabot-automerge.yml

@@ -0,0 +1,30 @@
+# Enable auto-merge on Dependabot PRs so GitHub merges them when required status checks pass.
+# Configure "Require status checks to pass before merging" in branch protection for the default branch.
+
+name: Dependabot automerge
+
+on: pull_request
+
+permissions:
+  contents: write
+  pull-requests: write
+
+env:
+  FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: true
+
+jobs:
+  dependabot:
+    runs-on: ubuntu-latest
+    if: github.event.pull_request.user.login == 'dependabot[bot]'
+    steps:
+      - name: Dependabot metadata
+        id: metadata
+        uses: dependabot/fetch-metadata@v2
+        with:
+          github-token: "${{ secrets.GITHUB_TOKEN }}"
+
+      - name: Enable auto-merge
+        run: gh pr merge --auto --merge "$PR_URL"
+        env:
+          PR_URL: ${{ github.event.pull_request.html_url }}
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

data/.github/workflows/main.yml

@@ -1,26 +1,82 @@
 name: Ruby
 
-on: [push,pull_request]
+on: [push, pull_request]
+
+env:
+  FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: true
 
 jobs:
+  glyptodont:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "3.2"
+          bundler-cache: false
+
+      - name: Install Glyptodont
+        run: gem install glyptodont
+
+      - name: Check TODOs
+        run: glyptodont
+
+  commit-messages:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+
+      - name: Check commit messages
+        run: |
+          if [ "${{ github.event_name }}" = "pull_request" ]; then
+            range="${{ github.event.pull_request.base.sha }}..${{ github.event.pull_request.head.sha }}"
+          else
+            before="${{ github.event.before }}"
+            if [ "$before" = "0000000000000000000000000000000000000000" ] || [ -z "$before" ]; then
+              range="${{ github.sha }}"
+            else
+              range="$before..${{ github.sha }}"
+            fi
+          fi
+          ./script/check-commit-messages "$range"
+
   build:
+    needs: commit-messages
     strategy:
       fail-fast: false
       matrix:
-        ruby: ['2.4', '2.5', '2.6', '2.7', '3.0']
+        ruby: ["3.2", "3.3", "3.4", "4.0"]
     runs-on: ubuntu-latest
     steps:
-    - name: Checkout
-      uses: actions/checkout@v2
-
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby }}
-
-    - name: Run The CI Build
-      run: |
-        gem install bundler
-        sudo apt install cmake
-        bundle install
-        ./script/cibuild
+      - name: Checkout
+        uses: actions/checkout@v6
+
+      - name: Set up Mise
+        uses: jdx/mise-action@v3
+        with:
+          tool_versions: |
+            ruby ${{ matrix.ruby }}
+            cmake
+          cache: true
+
+      - name: Cache Bundler
+        uses: actions/cache@v5
+        with:
+          path: vendor/bundle
+          key: bundle-${{ runner.os }}-${{ matrix.ruby }}-${{ hashFiles('**/Gemfile.lock') }}
+          restore-keys: |
+            bundle-${{ runner.os }}-${{ matrix.ruby }}-
+
+      - name: Install Bundler and gems
+        run: |
+          bundle config set path vendor/bundle
+          bundle install --jobs 4 --retry 3
+
+      - name: Run the CI build
+        run: ./script/cibuild

data/.github/workflows/publish-gem.yml

@@ -0,0 +1,42 @@
+# Publish to RubyGems.org when a version tag is pushed (e.g. by merging a Release Please PR).
+# Uses RubyGems Trusted Publishing (OIDC); no API key needed.
+# One-time setup: add this repo and workflow on https://rubygems.org (Trusted Publishers).
+
+name: Publish gem
+
+on:
+  push:
+    tags:
+      - "v*"
+
+env:
+  FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: true
+
+jobs:
+  push:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      id-token: write
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+        with:
+          persist-credentials: false
+
+      - name: Set up Mise
+        uses: jdx/mise-action@v3
+        with:
+          tool_versions: |
+            ruby 4.0
+            cmake
+          cache: true
+
+      - name: Install Bundler and gems
+        run: |
+          bundle config set path vendor/bundle
+          bundle install --jobs 4 --retry 3
+
+      - name: Publish to RubyGems.org
+        uses: rubygems/release-gem@v1

data/.github/workflows/release-please.yml

@@ -0,0 +1,28 @@
+name: Release Please
+
+on:
+  push:
+    branches:
+      - main
+      - master
+
+permissions:
+  contents: write
+  pull-requests: write
+
+env:
+  FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: true
+
+jobs:
+  release-please:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+
+      - name: Release Please
+        uses: googleapis/release-please-action@v4
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}

data/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "1.0.0"
+}

data/.rubocop.yml

@@ -1,7 +1,10 @@
 AllCops:
   NewCops: enable
-  SuggestExtensions: false
-  TargetRubyVersion: 2.4.0
+  TargetRubyVersion: 3.2
+
+plugins:
+  - rubocop-rake
+  - rubocop-rspec
 
 Style/StringLiterals:
   Enabled: true

data/.tool-versions

@@ -1 +1,3 @@
-ruby 3.0.0
+ruby 4.0
+cmake latest
+git-cliff latest

data/CHANGELOG.md

@@ -3,36 +3,145 @@
 All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
-and this project adheres to
-[Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.0](https://github.com/johnsyweb/glyptodont/compare/v0.3.0...v1.0.0) (2026-03-11)
+
+
+### ⚠ BREAKING CHANGES
+
+* drop support for Ruby < 3.2 (EOL); require Ruby 3.2+
+
+### Bug Fixes
+
+* do not require bundler/setup in executable ([83d4f0c](https://github.com/johnsyweb/glyptodont/commit/83d4f0ce45654ee683a807860dd28e81f44170e5))
+* use release-please-config.json so Release Please finds config ([c8c7f1b](https://github.com/johnsyweb/glyptodont/commit/c8c7f1b1f3cb6716e47838c2a744c03473c9f77d))
+* use release-please-config.json so Release Please finds config ([16f0f13](https://github.com/johnsyweb/glyptodont/commit/16f0f13a1b9fe6d3f3e03d20b28ea68e3fb31fe0))
+
+
+### Miscellaneous Chores
+
+* drop support for Ruby &lt; 3.2 (EOL); require Ruby 3.2+ ([0c0fbcd](https://github.com/johnsyweb/glyptodont/commit/0c0fbcde6748c7dca61bb2f8b09955b2b011a8c1))
 
 ## [Unreleased]
 
-[Unreleased]: https://github.com/johnsyweb/glyptodont/compare/v0.2.0..main
+### Changed
+
+- xp
+- drop support for Ruby < 3.2 (EOL); require Ruby 3.2+
+- add conventional commits changelog and release workflow
+- enforce conventional commits and run checks before each commit
+- add Release Please release bot
+- publish gem to RubyGems via Trusted Publishing on tag push
+- add documentation page for GitHub Pages
+- set homepage to docs at www.johnsy.com/glyptodont/
+- add Dependabot and automerge workflow for dependency updates
+- remove automerge setup note from README
+- check conventional commits only from first conventional commit onwards
+- add .nojekyll so GitHub Pages does not use Jekyll
+
+## [0.3.1] - 2026-03-11
+
+### Fixed
+
+- Do not require `bundler/setup` in the executable. The gem now runs correctly when the current directory has a Gemfile (e.g. in CI or when running in the gem's own repo).
+
+## [0.3.0] - 2022-03-23
+
+### Changed
+
+- Fix link
+
+- tyop
+
+- Support Ruby 2.5 through 3.1
+
+- Add Rubocop plugins
+
+- Improve gem description
+
+- Gemspec/RequireMFA
+
+- Lint/AmbiguousOperatorPrecedence
+
+- Update Changelog
+
+- Add keywords option/configuration for TODO synonyms
+
+- v0.3.0
+
+- 2022
+
+- Changelog for v0.3.0
+
+- Fix anchor
+
 
 ## [0.2.0] - 2021-03-28
 
-### Added
+### Changed
+
+- TODOs have moved
+
+- Cache the annotator for a file
+
+- See also!
+
+- return empty hash if the config file is empty
+
+- add rspec-its
+
+- add cmd-line options into config
+
+- pass ARGV to the initializer not the check
+
+- report all old TODOs, use age of the youngest in message
+
+- passing case wasn't handling the new threshold checking, fixed now
+
+- Style
 
-- Configuration settings for `max_age_in_days` and `threshold`, to allow for
-  setting these per project. [[#3]]
+- Move requirements around
+
+- Extract #stale_todos and #oldest_age
+
+- Spec for counter
+
+- Update configuration file
+
+- Document new configuration options
+
+- Changelog for v0.2.0
+
+- Fake configuration to make tests pass again
+
+- Run rubocop in ci
+
+- Bump version
+
+
+## [0.1.0] - 2021-03-16
 
 ### Changed
 
-- Report all old TODOs, use age of the youngest in message [[#2]]
+- Initial version
 
-### Fixed
+- //xkcd.com/149/
+
+- Allow for excluding certain lines
+
+- Handle missing / empty configuration
 
-- Handle empty configuration file [[#1]]
+- All or nothing
 
-[#1]: https://github.com/johnsyweb/glyptodont/pull/1
-[#2]: https://github.com/johnsyweb/glyptodont/pull/2
-[#3]: https://github.com/johnsyweb/glyptodont/pull/3
+- Use OptionParser to document command-line options
 
-[Unreleased]: https://github.com/johnsyweb/glyptodont/compare/v0.1.0..v0.2.0
+- Please Read Me
 
-## [0.1.0] - 2021-03-13
+- Test more Rubies
 
-- Initial release
 
+[Unreleased]: https://github.com/johnsyweb/glyptodont/compare/v0.3.0..HEAD
+[0.3.0]: https://github.com/johnsyweb/glyptodont/compare/v0.2.0..v0.3.0
+[0.2.0]: https://github.com/johnsyweb/glyptodont/compare/v0.1.0..v0.2.0
 [0.1.0]: https://github.com/johnsyweb/glyptodont/releases/tag/v0.1.0

data/Gemfile

@@ -2,12 +2,13 @@
 
 source "https://rubygems.org"
 
-# Specify your gem's dependencies in glyptodont.gemspec
 gemspec
 
-gem "rake", "~> 13.0"
-
-gem "rspec", "~> 3.0"
-gem "rspec-its", "~> 1.3.0"
-
-gem "rubocop", "~> 1.7"
+group :development, :test do
+  gem "rake"
+  gem "rspec"
+  gem "rspec-its"
+  gem "rubocop"
+  gem "rubocop-rake"
+  gem "rubocop-rspec"
+end

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2021 Pete Johns
+Copyright (c) 2021-2022 Pete Johns
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,7 +1,7 @@
 # Glyptodont
 
-Use this gem if you have ever deployed code to production without doing all of
-your to-dos.
+Use this gem if you want to avoid deploying code to production without doing all
+of your to-dos.
 
 ## Introduction
 
@@ -9,24 +9,47 @@ All of the glyptodonts have fossilised. This is a tool to ensure that your TODOs
 are eradicated before this can happen to them.
 
 If you've ever been caught out because a TODO in production code has not been
-don, this gem is for ***you***!
+_done_, this gem is for ***you***!
 
 ## Development status [![Ruby](https://github.com/johnsyweb/glyptodont/actions/workflows/main.yml/badge.svg)](https://github.com/johnsyweb/glyptodont/actions/workflows/main.yml)
 
 This was written after I was bitten by a TODO not being _done_ at work. I expect
 to build it into our CI pipeline and see what it catches.
 
-After checking out the project, run `script/setup` to install dependencies. Then,
-run `script/tests` to run the tests. You can also run `script/console` for an
-interactive prompt that will allow you to experiment.
+[Dependabot](https://docs.github.com/en/code-security/dependabot) is configured
+to open PRs for Bundler and GitHub Actions (weekly). A workflow enables
+auto-merge on those PRs so GitHub merges them when required status checks pass.
 
-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).
+After checking out the project, install [Mise](https://mise.jdx.dev/) (the only
+external prerequisite). Then run `script/setup`: it installs everything in
+`.tool-versions` (Ruby and CMake), the gem dependencies, and Git hooks that
+enforce [Conventional Commits](https://www.conventionalcommits.org/) and run
+`script/test` (RuboCop + RSpec) before each commit. Run `script/test` manually
+when needed; you can also run `script/console` for an interactive prompt.
 
-## Getting started [![Gem version](https://img.shields.io/gem/v/glyptodont.svg?style=flat-square)](https://github.com/johnysweb/glyptodont) [![Gem downloads](https://img.shields.io/gem/dt/glyptodont.svg?style=flat-square)](https://rubygems.org/gems/glyptodont)
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+### Releasing
+
+This project uses [Conventional Commits](https://www.conventionalcommits.org/).
+Releases can be created in two ways.
+
+**Release bot (recommended)**  
+[Release Please](https://github.com/googleapis/release-please-action) runs on pushes to
+`main`/`master`. It opens a **Release PR** that updates `lib/glyptodont/version.rb` and
+`CHANGELOG.md` from conventional commits. Merge that PR to create the Git tag and
+GitHub Release; the gem is then published to [rubygems.org](https://rubygems.org) via
+[Trusted Publishing](https://guides.rubygems.org/trusted-publishing/) (no API key in CI).
+
+**Manual release**  
+With [git-cliff](https://git-cliff.org/) installed (e.g. `mise install`):
+
+1. Bump the version in `lib/glyptodont/version.rb` (e.g. `0.4.0`).
+2. Commit the version bump.
+3. Run `bundle exec rake release` to create the tag, push it, and publish the gem.
+4. Run `rake changelog` (or `mise exec -- rake changelog`), then commit and push the updated `CHANGELOG.md`.
+
+## Getting started [![Gem version](https://img.shields.io/gem/v/glyptodont.svg?style=flat-square)](https://github.com/johnsyweb/glyptodont) [![Gem downloads](https://img.shields.io/gem/dt/glyptodont.svg?style=flat-square)](https://rubygems.org/gems/glyptodont)
 
 Add this line to your application's Gemfile:
 
@@ -46,49 +69,14 @@ Or install it yourself as:
 gem install glyptodont
 ```
 
-## Usage
-
-```
-Usage: glyptodont [options]
-    -d, --directory DIRECTORY        Git repository to search for TODOs (default '.')
-    -t, --threshold TODOS            Maximum number of TODOs to allow (default 10)
-    -m, --max-age DAYS               Maximum number of days to allow TODOs to stay (default 14)
-        --version                    Show version
-```
-
-## Configuration
-
-glyptodont looks for an optional `.glyptodont.yaml` configuration file in the
-root of the directory being scanned.
-
-### Sections
-
-- `threshold`: Maximum number of TODOs to allow. Can be overridden by
-  command-line options.
-- `max_age_in_days`: Maximum number of days to allow TODOs to stay. Can be
-  overridden by command-line options.
-- `ignore`: List of `file_name:line_number` pairs to ignore when researching
-  TODOs. This may be useful if you have, for example, Spanish language text in
-  your project or you talk about TODOs a lot :-)
-
-### _Exempli gratiā_
-
-```yaml
----
-threshold: 1
-max_age_in_days: 1
-ignore:
-  - README.md:11
-  - lib/glyptodont/checkers/counter.rb:30
-  - lib/glyptodont/todo_researcher.rb:33
-  - spec/checkers/counter_spec.rb:20
-```
+For usage, command-line options, configuration (`.glyptodont.yaml`), and CI
+examples (GitHub Actions, Buildkite, Docker), see the [documentation](https://www.johnsy.com/glyptodont/).
 
 ## Requirements
 
-- Ruby (tested against v2.4 and above)
-- Git
-- CMake
+- [Mise](https://mise.jdx.dev/) — install once; `script/setup` uses it to install
+  Ruby and CMake from `.tool-versions`.
+- Git — for development and for the rugged gem at runtime.
 
 ## Contributing
 

data/Rakefile

@@ -9,4 +9,9 @@ require "rubocop/rake_task"
 
 RuboCop::RakeTask.new
 
+desc "Regenerate CHANGELOG.md from conventional commits (requires git-cliff, e.g. via mise)"
+task :changelog do
+  system("git cliff -o CHANGELOG.md") || abort("changelog task failed")
+end
+
 task default: %i[spec rubocop]