Skip to content

Commit 5c6db99

Browse files
ksouthworthclaude
andcommitted
Release 0.5.2
Documentation and reporting only. Neither capture layer changes, and an application that upgrades sees no behaviour difference outside `rake audit_log:coverage`'s output. `audit_log:coverage` now leads its finding with a count and sorts the table list alphabetically -- `23 untracked tables: ...` rather than `Untracked tables: ...`, in name order rather than catalog order. Both are for the reader of a CI log, where that list is the part that scrolls: shown from the tail a forty-table wall reads as a handful of findings, and creation order is not what somebody scanning for the table they just added is using. The sort lives in `Coverage#missing` rather than at the point of display, and the count is spelled in the shared example in `audit_log/rspec` as well, because that message is a second rendering of the same finding and this class exists so the two cannot disagree about it. The install template's `unaudited_tables` block gains commented examples for Active Storage, Ahoy, PaperTrail's `versions` and the PostGIS reference tables. They stay commented and they stay in the HOST's initializer rather than becoming gem defaults, because the four defaults are tables no application could want audited and these are not: `active_storage_attachments` records who attached which file to which record, which is a real auditor question in a document-heavy app, and a default exemption there means coverage never asks it again, silently, in every adopting app. Hence the note beside that group -- three adjacent commented lines invite uncommenting all three, and that one is a decision rather than tidying up a red build. `--exclude` is now documented as space-separated in the `audit_log:trigger` options table. It is a Thor `type: :array`, so `--exclude=a,b` arrives as a single column name `a,b`, matches nothing, and leaves both columns in the diff while the generator reports success. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
1 parent 111b98a commit 5c6db99

3 files changed

Lines changed: 38 additions & 2 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,42 @@ versioning follows [SemVer](https://semver.org/spec/v2.0.0.html).
55

66
## Unreleased
77

8+
## 0.5.2 — 2026-09-09
9+
10+
Documentation and reporting only. No behaviour change to either capture layer.
11+
12+
### Changed
13+
14+
- **`audit_log:coverage` leads its finding with a count, and sorts the tables.**
15+
`23 untracked tables: ...` rather than `Untracked tables: ...`, alphabetically
16+
rather than in catalog order. Both are for the reader of a CI log, where that
17+
list is the part that scrolls: shown from the tail, a forty-table wall reads as
18+
a handful of findings, and creation order is not what somebody scanning for the
19+
table they just added is using.
20+
21+
The sort is in `AuditLog::Coverage#missing`, so the rake task, the
22+
capture-disabled report and any host calling `missing` directly share it. The
23+
count is spelled in the shared example in `audit_log/rspec` too — that message
24+
is a second rendering of the same finding, and this class exists so the two
25+
cannot disagree.
26+
27+
- **The install template's `unaudited_tables` block carries commented examples**
28+
for Active Storage, Ahoy, PaperTrail's `versions` and the PostGIS reference
29+
tables (`us_lex`, `us_gaz`, `us_rules`, `spatial_ref_sys`).
30+
31+
They stay commented, and they stay in the host's initializer rather than
32+
becoming gem defaults. The four defaults are tables no application could want
33+
audited; `active_storage_attachments` records who attached which file to which
34+
record, which is a real auditor question in a document-heavy app, and a default
35+
exemption would mean coverage never asks it again — silently, in every adopting
36+
app. That is the one thing the forcing function exists to prevent, so the group
37+
carries a note saying so.
38+
39+
- **`--exclude` is documented as space-separated** in the `audit_log:trigger`
40+
options table. It is a Thor `type: :array`, so `--exclude=a,b` arrives as one
41+
column name `a,b`, matches nothing, and leaves both columns in the diff while
42+
the generator reports success.
43+
844
## 0.5.1 — 2026-09-01
945

1046
### Changed

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@ command, and the reasoning for any of it is linked rather than inline.
219219

220220
```ruby
221221
# Gemfile
222-
gem "audit_log", git: "https://github.com/web-ascender/audit-log", tag: "v0.5.1"
222+
gem "audit_log", git: "https://github.com/web-ascender/audit-log", tag: "v0.5.2"
223223
```
224224

225225
A private repo, so `bundle` needs credentials for the company GitHub org. Pin to

‎lib/audit_log/version.rb‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# frozen_string_literal: true
22

33
module AuditLog
4-
VERSION = "0.5.1"
4+
VERSION = "0.5.2"
55
end

0 commit comments

Comments
 (0)