weeheavy/pelican-theme
1
0
Fork 0
forked from github/pelican
Code Pull requests Activity

Add Typogrify/SmartyPants dashes config parameter (#2615)

Browse source
This commit is contained in:
fancsali 2020-04-16 12:32:19 +01:00 • committed by GitHub
commit f610801ee8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
7 changed files with 101 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

8
pelican/readers.py
View file

@ -585,6 +585,14 @@ class Readers(FileStampDataCacher):
from typogrify.filters import typogrify
import smartypants
typogrify_dashes = self.settings['TYPOGRIFY_DASHES']
if typogrify_dashes == 'oldschool':
smartypants.Attr.default = smartypants.Attr.set2
elif typogrify_dashes == 'oldschool_inverted':
smartypants.Attr.default = smartypants.Attr.set3
else:
smartypants.Attr.default = smartypants.Attr.set1
# Tell `smartypants` to also replace " HTML entities with
# smart quotes. This is necessary because Docutils has already
# replaced double quotes with said entities by the time we run

1
pelican/settings.py
View file

@ -138,6 +138,7 @@ DEFAULT_CONFIG = {
'ARTICLE_PERMALINK_STRUCTURE': '',
'TYPOGRIFY': False,
'TYPOGRIFY_IGNORE_TAGS': [],
'TYPOGRIFY_DASHES': 'default',
'SUMMARY_END_MARKER': '…',
'SUMMARY_MAX_LENGTH': 50,
'PLUGIN_PATHS': [],

3
pelican/tests/content/article_with_typogrify_dashes.md vendored Normal file
View file

@ -0,0 +1,3 @@
Title: One -, two --, three --- dashes!
One: -; Two: --; Three: ---

4
pelican/tests/content/article_with_typogrify_dashes.rst vendored Normal file
View file

@ -0,0 +1,4 @@
One -, two --, three --- dashes!
################################
One: -; Two: --; Three: ---

6
pelican/tests/test_generators.py
View file

@ -248,6 +248,10 @@ class TestArticlesGenerator(unittest.TestCase):
['Article with template', 'published', 'Default', 'custom'],
['Metadata tags as list!', 'published', 'Default', 'article'],
['Rst with filename metadata', 'published', 'yeah', 'article'],
['One -, two --, three --- dashes!', 'published', 'Default',
'article'],
['One -, two --, three --- dashes!', 'published', 'Default',
'article'],
['Test Markdown extensions', 'published', 'Default', 'article'],
['Test markdown File', 'published', 'test', 'article'],
['Test md File', 'published', 'test', 'article'],
@ -562,6 +566,8 @@ class TestArticlesGenerator(unittest.TestCase):
'Article with markdown containing footnotes',
'Article with template',
'Metadata tags as list!',
'One -, two --, three --- dashes!',
'One -, two --, three --- dashes!',
'Rst with filename metadata',
'Test Markdown extensions',
'Test markdown File',

68
pelican/tests/test_readers.py
View file

@ -443,6 +443,40 @@ class RstReaderTest(ReaderTest):
with self.assertRaisesRegex(Exception, "underline too short"):
self.read_file(path='../parse_error/parse_error.rst')
def test_typogrify_dashes_config(self):
# Test default config
page = self.read_file(
path='article_with_typogrify_dashes.rst',
TYPOGRIFY=True,
TYPOGRIFY_DASHES='default')
expected = "<p>One: -; Two: &#8212;; Three:&nbsp;&#8212;-</p>\n"
expected_title = "One -, two &#8212;, three &#8212;-&nbsp;dashes!"
self.assertEqual(page.content, expected)
self.assertEqual(page.title, expected_title)
# Test 'oldschool' variant
page = self.read_file(
path='article_with_typogrify_dashes.rst',
TYPOGRIFY=True,
TYPOGRIFY_DASHES='oldschool')
expected = "<p>One: -; Two: &#8211;; Three:&nbsp;&#8212;</p>\n"
expected_title = "One -, two &#8211;, three &#8212;&nbsp;dashes!"
self.assertEqual(page.content, expected)
self.assertEqual(page.title, expected_title)
# Test 'oldschool_inverted' variant
page = self.read_file(
path='article_with_typogrify_dashes.rst',
TYPOGRIFY=True,
TYPOGRIFY_DASHES='oldschool_inverted')
expected = "<p>One: -; Two: &#8212;; Three:&nbsp;&#8211;</p>\n"
expected_title = "One -, two &#8212;, three &#8211;&nbsp;dashes!"
self.assertEqual(page.content, expected)
self.assertEqual(page.title, expected_title)
@unittest.skipUnless(readers.Markdown, "markdown isn't installed")
class MdReaderTest(ReaderTest):
@ -674,6 +708,40 @@ class MdReaderTest(ReaderTest):
self.assertEqual(metadata, {})
self.assertEqual(content, '')
def test_typogrify_dashes_config(self):
# Test default config
page = self.read_file(
path='article_with_typogrify_dashes.md',
TYPOGRIFY=True,
TYPOGRIFY_DASHES='default')
expected = "<p>One: -; Two: &#8212;; Three:&nbsp;&#8212;-</p>"
expected_title = "One -, two &#8212;, three &#8212;-&nbsp;dashes!"
self.assertEqual(page.content, expected)
self.assertEqual(page.title, expected_title)
# Test 'oldschool' variant
page = self.read_file(
path='article_with_typogrify_dashes.md',
TYPOGRIFY=True,
TYPOGRIFY_DASHES='oldschool')
expected = "<p>One: -; Two: &#8211;; Three:&nbsp;&#8212;</p>"
expected_title = "One -, two &#8211;, three &#8212;&nbsp;dashes!"
self.assertEqual(page.content, expected)
self.assertEqual(page.title, expected_title)
# Test 'oldschool_inverted' variant
page = self.read_file(
path='article_with_typogrify_dashes.md',
TYPOGRIFY=True,
TYPOGRIFY_DASHES='oldschool_inverted')
expected = "<p>One: -; Two: &#8212;; Three:&nbsp;&#8211;</p>"
expected_title = "One -, two &#8212;, three &#8211;&nbsp;dashes!"
self.assertEqual(page.content, expected)
self.assertEqual(page.title, expected_title)
class HTMLReaderTest(ReaderTest):
def test_article_with_comments(self):