fix: Editing of existing snippet not allowed (unversioned snippets)

[fsbraun]

Description

Fix for #176

Related resources

• Updating an existing Snippet results in invalid error message #176
• #...

Checklist

• I have opened this pull request against master
• I have added or modified the tests when changing logic
• I have followed the conventional commits guidelines to add meaningful information into the changelog
• I have read the contribution guidelines and I have joined #pr-review on
  Discord to find a “pr review buddy” who is
  going to review my pull request.

Summary by Sourcery

Bug Fixes:

• Fix incorrect filtering of snippets when editing.

[sourcery-ai]

Reviewer's Guide by Sourcery

The pull request fixes a bug that prevented editing existing snippets if they were not versioned. The fix removes versioning-specific logic from the snippet form's clean method, ensuring that the uniqueness validation works correctly for all snippets.

Sequence diagram for snippet editing validation

sequenceDiagram
    participant User as User
    participant Form as SnippetForm
    participant DB as Database

    User->>Form: Submit edited snippet
    Form->>DB: Query existing snippets
    Note right of Form: Now excludes only by snippet_grouper,
    Note right of Form: removed versioning check
    DB-->>Form: Return matching snippets
    Form->>Form: Validate name uniqueness
    alt Name is unique
        Form-->>User: Accept changes
    else Name exists
        Form-->>User: Show validation error
    end

Loading

Class diagram showing SnippetForm changes

classDiagram
    class SnippetForm {
        +clean()
    }
    note for SnippetForm "Simplified validation logic:
Removed versioning checks
Only excludes by snippet_grouper"

    class Snippet {
        +name: str
        +slug: str
        +snippet_grouper: SnippetGrouper
    }

    class SnippetGrouper {
    }

    SnippetForm ..> Snippet: validates
    Snippet --> SnippetGrouper: belongs to

Loading

File-Level Changes

Change	Details	Files
Removed versioning-specific logic from the snippet form's clean method.	Removed the conditional logic that excluded snippets based on versioning being enabled. Modified the snippet queryset to exclude snippets with the same snippet_grouper, regardless of versioning.	src/djangocms_snippet/forms.py

Possibly linked issues

• Updating an existing Snippet results in invalid error message #176: The PR fixes the issue described in the issue. The PR changes the clean method to allow editing existing snippets.

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!
• Generate a plan of action for an issue: Comment @sourcery-ai plan on
  an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey @fsbraun - I've reviewed your changes - here's some feedback:

Overall Comments:

• Please add documentation explaining why it's safe to remove the version checking logic and always exclude the snippet_grouper. This will help with future maintenance.

Here's what I looked at during the review

• 🟢 General issues: all looks good
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}