Replaced name generator for versioning for revisions - #24
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR replaces the prior “auto-generated revision name” mechanism with a dedicated, sequential integer version stored on each revision record, and removes the name generator contract/factory/config hooks accordingly.
Changes:
- Adds a
versioncolumn to revisions and assigns it during revision creation. - Removes the name-generator API (contract, factory, generator, config, and related tests) so
nameis now only caller-provided. - Updates documentation and tests to reflect version-based sequencing.
Reviewed changes
Copilot reviewed 16 out of 16 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| tests/RevisionVersioningTest.php | Adds coverage for sequential versioning, replace behavior, and rollback continuation. |
| tests/RevisionNamingTest.php | Updates naming tests to reflect “no auto-name by default” and manual naming behavior. |
| tests/Database/Migrations/0000_00_00_000000_create_testing_tables.php | Adds version column to the test revisions table. |
| tests/CreatingRevisionsTest.php | Updates direct DB inserts to include version. |
| tests/ConfigurationTest.php | Removes name-generator configuration tests. |
| src/Revisioner.php | Stops resolving names via generator; assigns version on build. |
| src/RevisableOptions.php | Removes name-generator option and factory initialization. |
| src/Models/Revision.php | Adds version to $fillable and $casts. |
| src/Generators/VersionNameGenerator.php | Removed (no longer used). |
| src/Generators/NameGeneratorFactory.php | Removed (no longer used). |
| src/Exceptions/InvalidConfiguration.php | Removes invalid-name-generator exception helper. |
| src/Contracts/NameGenerator.php | Removed (no longer used). |
| src/Concerns/HasRevisions.php | Removes wiring of options-based name generator into the revisioner. |
| README.md | Replaces “custom revision naming” docs with “version numbers”. |
| database/migrations/create_revisions_table.php.stub | Adds version column to published migration stub. |
| config/revisionable.php | Removes name_generator config option. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+210
to
213
| protected function resolveVersion(): int | ||
| { | ||
| if ($this->name !== null) { | ||
| return $this->name; | ||
| } | ||
|
|
||
| return $this->nameGenerator?->generate($this->model); | ||
| return $this->model->revisions()->count() + 1; | ||
| } |
Comment on lines
15
to
18
| $table->morphs('revisionable'); | ||
| $table->string('name')->nullable(); | ||
| $table->unsignedInteger('version'); | ||
| $table->json('metadata')->nullable(); |
Comment on lines
90
to
93
| $table->morphs('revisionable'); | ||
| $table->string('name')->nullable(); | ||
| $table->unsignedInteger('version'); | ||
| $table->json('metadata')->nullable(); |
Comment on lines
+292
to
295
| #### Version numbers | ||
|
|
||
| The default `VersionNameGenerator` names revisions sequentially (v1, v2, …). You can provide your own generator by implementing the `NameGenerator` contract and registering it in the options: | ||
| Every revision automatically gets a sequential `version` number (1, 2, 3, …), scoped to its model instance. Unlike a generated name, the version is a plain integer, so it carries no language or formatting choices — prefix it with whatever translated string fits your application: | ||
|
|
Contributor
Author
There was a problem hiding this comment.
No release yet, so no worries there.
…unique constraints for revisions
Comment on lines
110
to
114
| $revision->user_id = $this->userResolver->resolve(); | ||
| $revision->name = $this->resolveName(); | ||
| $revision->name = $this->name; | ||
| $revision->version = $this->resolveVersion(); | ||
| $revision->metadata = $this->buildData(); | ||
| $revision->changed = $this->buildChanges($revision); |
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 16 out of 16 changed files in this pull request and generated no new comments.
Comments suppressed due to low confidence (1)
src/Revisioner.php:134
resolveVersion()is computed asmax(version) + 1inside the transaction, but without any locking this is still vulnerable to concurrent saves on the same model: two transactions can read the same max and then one will fail on the unique constraint. If the intent is to makeversionreliably sequential, consider serializing per-model revision creation by taking a row lock on the revisionable model before computing the next version (SQLite will ignore the lock, MySQL/Postgres will enforce it).
public function save(): Revision
{
return DB::transaction(function () {
$revision = $this->build();
$revision->version = $this->resolveVersion();
$this->model->revisions()->save($revision);
$this->prune();
return $revision;
});
Frankisgek
approved these changes
Jul 16, 2026
stefanius
approved these changes
Jul 16, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.