github/pelican
1
0
Fork 1
mirror of https://github.com/getpelican/pelican.git synced 2025-10-15 20:28:56 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

fix: SUMMARY_MAX_PARAGRAPHS not respected in some combinations with SUMMARY_MAX_LENGTH (#3427)

Browse source
This commit is contained in:
Scott Colby 2024-11-27 14:51:03 -05:00 • committed by GitHub
commit d9652ef109
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 31 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

4
RELEASE.md Normal file
View file

@ -0,0 +1,4 @@
Release type: patch
- Change ``IGNORE_FILES`` setting default to ignore all hidden files
- Fix ``SUMMARY_MAX_PARAGRAPHS`` not being respected in some combinations with ``SUMMARY_MAX_LENGTH``

2
pelican/contents.py
View file

@ -451,7 +451,7 @@ class Content:
return content return content
return truncate_html_words( return truncate_html_words(
self.content, content,
self.settings["SUMMARY_MAX_LENGTH"], self.settings["SUMMARY_MAX_LENGTH"],
self.settings["SUMMARY_END_SUFFIX"], self.settings["SUMMARY_END_SUFFIX"],
) )

30
pelican/tests/test_contents.py
View file

@ -13,8 +13,12 @@ from pelican.settings import DEFAULT_CONFIG
from pelican.tests.support import LoggedTestCase, get_context, get_settings, unittest from pelican.tests.support import LoggedTestCase, get_context, get_settings, unittest
from pelican.utils import path_to_url, posixize_path, truncate_html_words from pelican.utils import path_to_url, posixize_path, truncate_html_words
# generate one paragraph, enclosed with <p> # generate 3 test paragraphs, each enclosed with <p>
TEST_CONTENT = str(generate_lorem_ipsum(n=1)) # save the first paragraph separately for testing the summary generation algorithm
# NOTE: these values are nondeterministic between test runs
TEST_CONTENT_FIRST_PARAGRAPH = str(generate_lorem_ipsum(n=1))
TEST_CONTENT_REMAINING_PARAGRAPHS = str(generate_lorem_ipsum(n=2))
TEST_CONTENT = TEST_CONTENT_FIRST_PARAGRAPH + TEST_CONTENT_REMAINING_PARAGRAPHS
TEST_SUMMARY = generate_lorem_ipsum(n=1, html=False) TEST_SUMMARY = generate_lorem_ipsum(n=1, html=False)
@ -126,7 +130,7 @@ class TestPage(TestBase):
settings["SUMMARY_MAX_PARAGRAPHS"] = 1 settings["SUMMARY_MAX_PARAGRAPHS"] = 1
settings["SUMMARY_MAX_LENGTH"] = None settings["SUMMARY_MAX_LENGTH"] = None
page = Page(**page_kwargs) page = Page(**page_kwargs)
self.assertEqual(page.summary, TEST_CONTENT) self.assertEqual(page.summary, TEST_CONTENT_FIRST_PARAGRAPH)
def test_summary_paragraph_max_length(self): def test_summary_paragraph_max_length(self):
# If both SUMMARY_MAX_PARAGRAPHS and SUMMARY_MAX_LENGTH are set, # If both SUMMARY_MAX_PARAGRAPHS and SUMMARY_MAX_LENGTH are set,
@ -139,7 +143,25 @@ class TestPage(TestBase):
settings["SUMMARY_MAX_PARAGRAPHS"] = 1 settings["SUMMARY_MAX_PARAGRAPHS"] = 1
settings["SUMMARY_MAX_LENGTH"] = 10 settings["SUMMARY_MAX_LENGTH"] = 10
page = Page(**page_kwargs) page = Page(**page_kwargs)
self.assertEqual(page.summary, truncate_html_words(TEST_CONTENT, 10)) self.assertEqual(
page.summary, truncate_html_words(TEST_CONTENT_FIRST_PARAGRAPH, 10)
)
def test_summary_paragraph_long_max_length(self):
# If both SUMMARY_MAX_PARAGRAPHS and SUMMARY_MAX_LENGTH are set,
# and the first SUMMARY_MAX_PARAGRAPHS paragraphs have fewer words
# than SUMMARY_MAX_LENGTH, the generated summary should still only
# contain the given number of paragraphs.
page_kwargs = self._copy_page_kwargs()
settings = get_settings()
page_kwargs["settings"] = settings
del page_kwargs["metadata"]["summary"]
settings["SUMMARY_MAX_PARAGRAPHS"] = 1
settings["SUMMARY_MAX_LENGTH"] = 50
page = Page(**page_kwargs)
self.assertEqual(
page.summary, truncate_html_words(TEST_CONTENT_FIRST_PARAGRAPH, 50)
)
def test_summary_end_suffix(self): def test_summary_end_suffix(self):
# If a :SUMMARY_END_SUFFIX: is set, and there is no other summary, # If a :SUMMARY_END_SUFFIX: is set, and there is no other summary,