feat: Improve default copy method to also copy placeholders and plugins

[fsbraun]

Description

Versioning allows specifying a copy method to allow for copying foreign keys, one-to-one fields in a meaningful way for the specific model.

One of the most relevant relations will be placeholders and their plugins.

To avoid code repetition of largely identical copy methods in any package using djangocms-versioning, I propose to include coyping placeholders in versioned models by default.

This would make custom copy functions obsolete in alias and blog and other content objects to come.

Also, if the verisoned model has a method copy_relations it is called on the new object allowing to keep simple copy information within the model.

Tests follow.

Related resources

• #...
• #...

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 #workgroup-pr-review on
  Slack to find a “pr review buddy” who is going to review my pull request.

Summary by Sourcery

Improves the default copy method to also copy placeholders and plugins, and introduces a mechanism to allow versioned models to define custom copy logic.

Enhancements:

• Extends the default copy method to include placeholders and their associated plugins.
• Adds a mechanism to call a copy_relations method on the new object if it exists, allowing models to define custom copy logic.

[codecov]

Codecov Report

Attention: Patch coverage is 88.88889% with 3 lines in your changes missing coverage. Please review.

Project coverage is 90.54%. Comparing base (7a5e73a) to head (b559e5b).
Report is 1 commits behind head on master.

Files with missing lines	Patch %	Lines
djangocms_versioning/datastructures.py	88.88%	0 Missing and 2 partials ⚠️
djangocms_versioning/admin.py	75.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #345      +/-   ##
==========================================
- Coverage   90.55%   90.54%   -0.01%     
==========================================
  Files          72       72              
  Lines        2720     2729       +9     
  Branches      318      321       +3     
==========================================
+ Hits         2463     2471       +8     
  Misses        182      182              
- Partials       75       76       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request enhances the default copy method to include copying placeholders and plugins, reducing code duplication across various packages using djangocms-versioning. It also introduces a copy_relations method on versioned models to allow for simple copy information to be kept within the model.

Updated class diagram for default_copy function

classDiagram
    class default_copy{
        +default_copy(original_content)
        +content_fields
        +new_content
        +new_placeholders
        +placeholder_fields
        +new_placeholder
    }
    class Placeholder{
        -_meta
        +objects
        +copy_plugins(new_placeholder)
    }
    default_copy -- Placeholder : creates
    note for default_copy "Copies placeholders and plugins by default"

Loading

File-Level Changes

Change	Details	Files
The default copy method was improved to copy placeholders and plugins.	The default_copy function now copies placeholders and their plugins. The default_copy function now calls a copy_relations method on the new object if it exists and is callable.	djangocms_versioning/datastructures.py tests/test_datastructures.py djangocms_versioning/cms_config.py
The copy_page_content function in cms_config.py was updated to use the new default_copy function.	The copy_page_content function now uses the default_copy function to copy the PageContent object. The creation_date attribute of the new content is set to the current time after the copy.	djangocms_versioning/cms_config.py

---

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:

• The new tests are good, but could be improved by using self.assertIsInstance instead of creating a MockContent class.
• Consider adding a test case where copy_relations exists but is not callable.

Here's what I looked at during the review

• 🟢 General issues: all looks good
• 🟢 Security: all looks good
• 🟡 Testing: 3 issues found
• 🟡 Complexity: 1 issue found
• 🟢 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.}