Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

bugfix: fix a bug where custom serializer blocks can fail if after a … (Sourcery refactored) #45

Conversation

sourcery-ai[bot]
Copy link

@sourcery-ai sourcery-ai bot commented Jun 20, 2022

Pull Request #44 refactored by Sourcery.

If you're happy with these changes, merge this Pull Request using the Squash and merge strategy.

NOTE: As code is pushed to the original Pull Request, Sourcery will
re-run and update (force-push) this Pull Request with new refactorings as
necessary. If Sourcery finds no refactorings at any point, this Pull Request
will be closed automatically.

See our documentation here.

Run Sourcery locally

Reduce the feedback loop during development by using the Sourcery editor plugin:

Review changes via command line

To manually merge these changes, make sure you're on the espenra/custom-serializer-after-list-bug branch, then run:

git fetch origin sourcery/espenra/custom-serializer-after-list-bug
git merge --ff-only FETCH_HEAD
git reset HEAD^

Help us improve this pull request!

sondrelg and others added 3 commits April 27, 2022 10:15
…list

This commit fixes a bug where the rendering of a node can fail
if it has fields not supported by Block and follows directly after
a list item.

The list item logic would pass in the first node after the list as context
and cast it to a Block. This fails if the node has fields not supported
by Block. Which is the case for custom serializer blocks.

The context is actually not used, and removing it solves the bug.
@sourcery-ai sourcery-ai bot requested a review from Kakebake June 20, 2022 14:18
Comment on lines -211 to +215
parent = self._find_list(tree[-1], level=node.get('level'), list_item=node.get('listItem'))
if parent:
if parent := self._find_list(
tree[-1],
level=node.get('level'),
list_item=node.get('listItem'),
):
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Function PortableTextRenderer._normalize_list_tree refactored with the following changes:

Comment on lines -243 to +246
children = root_node.get('children')
if children:
if children := root_node.get('children'):
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Function PortableTextRenderer._find_list refactored with the following changes:

@sourcery-ai
Copy link
Author

sourcery-ai bot commented Jun 20, 2022

Sourcery Code Quality Report

Merging this PR leaves code quality unchanged.

Quality metrics Before After Change
Complexity 11.67 🙂 11.66 🙂 -0.01 👍
Method Length 85.55 🙂 85.36 🙂 -0.19 👍
Working memory 9.11 🙂 9.12 🙂 0.01 👎
Quality 57.10% 🙂 57.10% 🙂 0.00%
Other metrics Before After Change
Lines 247 249 2
Changed files Quality Before Quality After Quality Change
portabletext_html/renderer.py 57.10% 🙂 57.10% 🙂 0.00%

Here are some functions in these files that still need a tune-up:

File Function Complexity Length Working Memory Quality Recommendation
portabletext_html/renderer.py PortableTextRenderer._normalize_list_tree 21 😞 214 ⛔ 10 😞 38.80% 😞 Refactor to reduce nesting. Try splitting into smaller methods. Extract out complex expressions
portabletext_html/renderer.py PortableTextRenderer._render_span 16 🙂 160 😞 11 😞 45.12% 😞 Try splitting into smaller methods. Extract out complex expressions
portabletext_html/renderer.py PortableTextRenderer._render_node 8 ⭐ 132 😞 9 🙂 59.14% 🙂 Try splitting into smaller methods
portabletext_html/renderer.py PortableTextRenderer.render 9 🙂 124 😞 9 🙂 59.16% 🙂 Try splitting into smaller methods

Legend and Explanation

The emojis denote the absolute quality of the code:

  • ⭐ excellent
  • 🙂 good
  • 😞 poor
  • ⛔ very poor

The 👍 and 👎 indicate whether the quality has improved or gotten worse with this pull request.


Please see our documentation here for details on how these metrics are calculated.

We are actively working on this report - lots more documentation and extra metrics to come!

Help us improve this quality report!

@Kakebake Kakebake force-pushed the espenra/custom-serializer-after-list-bug branch from e6949b0 to 69fa475 Compare June 20, 2022 14:20
@sourcery-ai sourcery-ai bot closed this Jun 20, 2022
@sourcery-ai sourcery-ai bot deleted the sourcery/espenra/custom-serializer-after-list-bug branch June 20, 2022 14:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants