feat: Remove explicit django CMS dependency #36

fsbraun · 2024-12-08T19:16:47Z

Summary by Sourcery

Remove the explicit dependency on django CMS by conditionally importing CMS-related modules and functionalities only if 'cms' is installed. This change allows the package to be used independently of django CMS, enhancing its flexibility and usability in different environments. Update the package version to 0.4.0 to reflect these changes.

Enhancements:

Make the django CMS dependency optional by checking if 'cms' is installed before importing related modules and functionalities.

Chores:

Update the package version from 0.3.3 to 0.4.0 to reflect the changes.

sourcery-ai · 2024-12-08T19:16:51Z

Reviewer's Guide by Sourcery

This PR removes the explicit dependency on django CMS, making the package more flexible by allowing it to be used independently. The implementation wraps django CMS-specific code in conditional imports and adds checks to ensure proper configuration when django CMS is not present. The changes primarily focus on restructuring the code to handle both django CMS and non-django CMS scenarios.

Class diagram for AbstractText with conditional CMSPlugin

classDiagram
    class AbstractText {
        +OneToOneField cmsplugin_ptr
        +TextField body
        +JSONField json
        +CharField rte
        +search_fields
        +__str__()
        +__init__(*args, **kwargs)
        +clean()
        +save(*args, **kwargs)
        +clean_plugins()
        +copy_referenced_plugins()
        +get_referenced_plugins()
        +add_existing_child_plugins_to_pairs(plugins_pairs)
        +_get_inline_plugin_ids()
        +post_copy(old_instance, ziplist)
        +notify_on_autoadd_children(request, conf, children)
    }
    class CMSPlugin {
    }
    AbstractText --> CMSPlugin : "if apps.is_installed('cms')"

Class diagram for TextConfig with new check_no_cms_config

classDiagram
    class TextConfig {
        +ready()
    }
    class AppConfig {
    }
    TextConfig --> AppConfig
    TextConfig : +check_no_cms_config()

File-Level Changes

Change	Details	Files
Introduce conditional django CMS imports and functionality	Wrap django CMS imports in `apps.is_installed('cms')` checks Move Text and AbstractText model definitions inside conditional block Refactor plugin discovery to work with and without django CMS	`djangocms_text/models.py` `djangocms_text/apps.py`
Add configuration validation for non-django CMS usage	Add check to ensure migrations are deactivated when django CMS is not installed Implement check_no_cms_config function to validate settings	`djangocms_text/apps.py`
Refactor utility functions and dependencies	Move get_url_endpoint function to widgets.py Update imports to use correct toolbar base classes Remove django CMS as a required dependency in pyproject.toml	`djangocms_text/utils.py` `djangocms_text/widgets.py` `djangocms_text/cms_toolbars.py` `pyproject.toml`
Update version and documentation	Bump version from 0.3.3 to 0.4.0 Remove django-cms>=3.11 from dependencies list	`djangocms_text/__init__.py` `pyproject.toml`

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.
Generate a pull request title: Write @sourcery-ai anywhere in the pull
request title to generate a 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. You can also use
this command to specify where the summary should be inserted.

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

We have skipped reviewing this pull request. We don't review packaging changes - Let us know if you'd like us to change this.

codecov · 2024-12-08T19:18:00Z

Codecov Report

Attention: Patch coverage is 87.12871% with 13 lines in your changes missing coverage. Please review.

Project coverage is 80.43%. Comparing base (1fd3132) to head (119dd76).
Report is 2 commits behind head on main.

Files with missing lines	Patch %	Lines
djangocms_text/apps.py	42.85%	5 Missing and 3 partials ⚠️
djangocms_text/models.py	93.90%	3 Missing and 2 partials ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #36      +/-   ##
==========================================
+ Coverage   80.21%   80.43%   +0.21%     
==========================================
  Files          17       17              
  Lines         940      930      -10     
  Branches      106      104       -2     
==========================================
- Hits          754      748       -6     
+ Misses        143      138       -5     
- Partials       43       44       +1

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

sveetch · 2024-12-09T00:07:55Z

Hi,

Does this means this package would be usable without djangocms ?

fsbraun · 2024-12-09T06:29:11Z

This is what I would like to put up for discussion. It would only offer an HTMLField and the dynamic link capability would not work (without a third-party extension). More changes than this PR are required.

sveetch · 2024-12-09T10:42:44Z

That would be very interesting so we could introduce its usage in non-cms apps that live in a CMS project to have the same editor everywhere, however i imagine it could be difficult to manage with the cms specific features.

It would only offer an HTMLField

The HTMLField is nice but from experience i think the widget would be important also.

fsbraun · 2024-12-09T12:26:20Z

@sveetch That's already possible today: You can use HTMLField in any non-CMS app within a CMS project. In the future, you could use HTMLField also in a non-CMS project and later add django CMS.

vinitkumar · 2024-12-09T16:59:16Z

This is a great idea. Let's do it.

fsbraun · 2024-12-10T11:06:10Z

@sourcery-ai review

sourcery-ai

Hey @fsbraun - I've reviewed your changes and found some issues that need to be addressed.

Blocking issues:

The MIGRATION_MODULES setting should be a dictionary, not a list (link)

Overall Comments:

There appears to be an import error - get_url_endpoint() was moved to widgets.py but utils.py still shows up as an import source in some files. This needs to be fixed to prevent runtime errors.

Here's what I looked at during the review

🔴 General issues: 1 blocking issue
🟢 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 ✨

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

README.rst

djangocms_text/models.py

fsbraun · 2024-12-10T11:23:29Z

@sourcery-ai review

sourcery-ai

Hey @fsbraun - I've reviewed your changes and they look great!

Here's what I looked at during the review

🟢 General issues: all looks good
🟢 Security: all looks good
🟢 Testing: all looks good
🟡 Complexity: 1 issue found
🟢 Documentation: all looks good

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

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

djangocms_text/apps.py

fsbraun · 2024-12-10T11:27:46Z

@sourcery-ai review

sourcery-ai

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

Overall Comments:

Consider adding documentation about the features and limitations when using the package without django CMS

Here's what I looked at during the review

🟡 General issues: 1 issue found
🟢 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 ✨

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

djangocms_text/apps.py

feat: Remove explicit django CMS dependency

5b62742

sourcery-ai bot reviewed Dec 8, 2024

View reviewed changes

vinitkumar approved these changes Dec 9, 2024

View reviewed changes

fsbraun added 4 commits December 10, 2024 09:41

Make cms dependency soft

9dd5c01

Update readme

94cec04

Fix tests

dc7b608

Bump version

42f771b

Update readme

e499a8d

sourcery-ai bot reviewed Dec 10, 2024

View reviewed changes

README.rst Outdated Show resolved Hide resolved

djangocms_text/models.py Outdated Show resolved Hide resolved

djangocms_text/models.py Outdated Show resolved Hide resolved

djangocms_text/models.py Outdated Show resolved Hide resolved

fsbraun added 5 commits December 10, 2024 12:11

Fix typo, implement sourcery suggestions

0c465eb

Fix one more sourcery suggestion

f139f30

Fix typo

f3ecc14

Fix ruff formats

e313cbf

Update pragma nocover

f46d53f

sourcery-ai bot reviewed Dec 10, 2024

View reviewed changes

djangocms_text/apps.py Show resolved Hide resolved

Simplify check for cms config

5e7b967

sourcery-ai bot reviewed Dec 10, 2024

View reviewed changes

djangocms_text/apps.py Outdated Show resolved Hide resolved

Improved error message

119dd76

fsbraun merged commit 696b3ee into main Dec 10, 2024
31 checks passed

fsbraun deleted the feat/no-cms-dependency branch December 10, 2024 11:34

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Remove explicit django CMS dependency #36

feat: Remove explicit django CMS dependency #36

fsbraun commented Dec 8, 2024 •

edited by sourcery-ai bot

Loading

sourcery-ai bot commented Dec 8, 2024 •

edited

Loading

Interacting with Sourcery

Customizing Your Experience

Getting Help

sourcery-ai bot left a comment

codecov bot commented Dec 8, 2024 •

edited

Loading

sveetch commented Dec 9, 2024

fsbraun commented Dec 9, 2024 •

edited

Loading

sveetch commented Dec 9, 2024 •

edited

Loading

fsbraun commented Dec 9, 2024

vinitkumar commented Dec 9, 2024

fsbraun commented Dec 10, 2024

sourcery-ai bot left a comment

fsbraun commented Dec 10, 2024

sourcery-ai bot left a comment

fsbraun commented Dec 10, 2024

sourcery-ai bot left a comment

feat: Remove explicit django CMS dependency #36

feat: Remove explicit django CMS dependency #36

Conversation

fsbraun commented Dec 8, 2024 • edited by sourcery-ai bot Loading

Summary by Sourcery

sourcery-ai bot commented Dec 8, 2024 • edited Loading

Reviewer's Guide by Sourcery

Class diagram for AbstractText with conditional CMSPlugin

Class diagram for TextConfig with new check_no_cms_config

File-Level Changes

Interacting with Sourcery

Customizing Your Experience

Getting Help

sourcery-ai bot left a comment

Choose a reason for hiding this comment

codecov bot commented Dec 8, 2024 • edited Loading

Codecov Report

sveetch commented Dec 9, 2024

fsbraun commented Dec 9, 2024 • edited Loading

sveetch commented Dec 9, 2024 • edited Loading

fsbraun commented Dec 9, 2024

vinitkumar commented Dec 9, 2024

fsbraun commented Dec 10, 2024

sourcery-ai bot left a comment

Choose a reason for hiding this comment

fsbraun commented Dec 10, 2024

sourcery-ai bot left a comment

Choose a reason for hiding this comment

fsbraun commented Dec 10, 2024

sourcery-ai bot left a comment

Choose a reason for hiding this comment

fsbraun commented Dec 8, 2024 •

edited by sourcery-ai bot

Loading

sourcery-ai bot commented Dec 8, 2024 •

edited

Loading

codecov bot commented Dec 8, 2024 •

edited

Loading

fsbraun commented Dec 9, 2024 •

edited

Loading

sveetch commented Dec 9, 2024 •

edited

Loading