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

Merge pull request #795 from wking/read-file

Browse source 
Generate context objects in read_file()
This commit is contained in:
Justin Mayer 2013-06-15 11:54:32 -07:00
commit 5d9b3d7777
12 changed files with 297 additions and 166 deletions
Download patch file Download diff file Expand all files Collapse all files

13
pelican/tests/default_conf.py
View file

@ -29,11 +29,16 @@ SOCIAL = (('twitter', 'http://twitter.com/ametaireau'),
# global metadata to all the contents
DEFAULT_METADATA = (('yeah', 'it is'),)
# static paths will be copied under the same name
STATIC_PATHS = ["pictures", ]
# path-specific metadata
EXTRA_PATH_METADATA = {
'extra/robots.txt': {'path': 'robots.txt'},
}
# A list of files to copy from the source to the destination
FILES_TO_COPY = (('extra/robots.txt', 'robots.txt'),)
# static paths will be copied without parsing their contents
STATIC_PATHS = [
'pictures',
'extra/robots.txt',
]
# foobar will not be used, because it's not in caps. All configuration keys
# have to be in caps

18
pelican/tests/test_generators.py
View file

@ -15,6 +15,7 @@ from pelican.settings import DEFAULT_CONFIG
from pelican.tests.support import unittest, get_settings
CUR_DIR = os.path.dirname(__file__)
CONTENT_DIR = os.path.join(CUR_DIR, 'content')
class TestArticlesGenerator(unittest.TestCase):
@ -30,12 +31,10 @@ class TestArticlesGenerator(unittest.TestCase):
"""
if self.generator is None:
settings = get_settings(filenames={})
settings['ARTICLE_DIR'] = 'content'
settings['DEFAULT_CATEGORY'] = 'Default'
settings['DEFAULT_DATE'] = (1970, 1, 1)
self.generator = ArticlesGenerator(settings.copy(), settings,
CUR_DIR, settings['THEME'], None,
settings['MARKUP'])
CONTENT_DIR, settings['THEME'], None, settings['MARKUP'])
self.generator.generate_context()
return self.generator
@ -118,14 +117,13 @@ class TestArticlesGenerator(unittest.TestCase):
def test_do_not_use_folder_as_category(self):
settings = DEFAULT_CONFIG.copy()
settings['ARTICLE_DIR'] = 'content'
settings['DEFAULT_CATEGORY'] = 'Default'
settings['DEFAULT_DATE'] = (1970, 1, 1)
settings['USE_FOLDER_AS_CATEGORY'] = False
settings['filenames'] = {}
generator = ArticlesGenerator(
settings.copy(), settings, CUR_DIR, DEFAULT_CONFIG['THEME'], None,
DEFAULT_CONFIG['MARKUP'])
settings.copy(), settings, CONTENT_DIR, DEFAULT_CONFIG['THEME'],
None, DEFAULT_CONFIG['MARKUP'])
generator.generate_context()
# test for name
# categories are grouped by slug; if two categories have the same slug
@ -213,12 +211,12 @@ class TestPageGenerator(unittest.TestCase):
def test_generate_context(self):
settings = get_settings(filenames={})
settings['PAGE_DIR'] = 'TestPages'
settings['PAGE_DIR'] = 'TestPages' # relative to CUR_DIR
settings['DEFAULT_DATE'] = (1970, 1, 1)
generator = PagesGenerator(settings.copy(), settings, CUR_DIR,
settings['THEME'], None,
settings['MARKUP'])
generator = PagesGenerator(
settings.copy(), settings, CUR_DIR, settings['THEME'], None,
settings['MARKUP'])
generator.generate_context()
pages = self.distill_pages(generator.pages)
hidden_pages = self.distill_pages(generator.hidden_pages)

72
pelican/tests/test_readers.py
View file

@ -20,13 +20,13 @@ class ReaderTest(unittest.TestCase):
def read_file(self, path, **kwargs):
# Isolate from future API changes to readers.read_file
return readers.read_file(
_path(path), settings=get_settings(**kwargs))
base_path=CONTENT_PATH, path=path, settings=get_settings(**kwargs))
class RstReaderTest(ReaderTest):
def test_article_with_metadata(self):
content, metadata = self.read_file(path='article_with_metadata.rst')
page = self.read_file(path='article_with_metadata.rst')
expected = {
'category': 'yeah',
'author': 'Alexis Métaireau',
@ -40,10 +40,10 @@ class RstReaderTest(ReaderTest):
}
for key, value in expected.items():
self.assertEqual(value, metadata[key], key)
self.assertEqual(value, page.metadata[key], key)
def test_article_with_filename_metadata(self):
content, metadata = self.read_file(
page = self.read_file(
path='2012-11-29_rst_w_filename_meta#foo-bar.rst',
FILENAME_METADATA=None)
expected = {
@ -51,10 +51,10 @@ class RstReaderTest(ReaderTest):
'author': 'Alexis Métaireau',
'title': 'Rst with filename metadata',
}
for key, value in metadata.items():
for key, value in page.metadata.items():
self.assertEqual(value, expected[key], key)
content, metadata = self.read_file(
page = self.read_file(
path='2012-11-29_rst_w_filename_meta#foo-bar.rst',
FILENAME_METADATA='(?P<date>\d{4}-\d{2}-\d{2}).*')
expected = {
@ -63,10 +63,10 @@ class RstReaderTest(ReaderTest):
'title': 'Rst with filename metadata',
'date': datetime.datetime(2012, 11, 29),
}
for key, value in metadata.items():
for key, value in page.metadata.items():
self.assertEqual(value, expected[key], key)
content, metadata = self.read_file(
page = self.read_file(
path='2012-11-29_rst_w_filename_meta#foo-bar.rst',
FILENAME_METADATA=(
'(?P<date>\d{4}-\d{2}-\d{2})_'
@ -80,7 +80,7 @@ class RstReaderTest(ReaderTest):
'slug': 'article_with_filename_metadata',
'mymeta': 'foo',
}
for key, value in metadata.items():
for key, value in page.metadata.items():
self.assertEqual(value, expected[key], key)
def test_article_metadata_key_lowercase(self):
@ -96,23 +96,23 @@ class RstReaderTest(ReaderTest):
def test_typogrify(self):
# if nothing is specified in the settings, the content should be
# unmodified
content, _ = self.read_file(path='article.rst')
page = self.read_file(path='article.rst')
expected = ('<p>This is some content. With some stuff to '
'&quot;typogrify&quot;.</p>\n<p>Now with added '
'support for <abbr title="three letter acronym">'
'TLA</abbr>.</p>\n')
self.assertEqual(content, expected)
self.assertEqual(page.content, expected)
try:
# otherwise, typogrify should be applied
content, _ = self.read_file(path='article.rst', TYPOGRIFY=True)
page = self.read_file(path='article.rst', TYPOGRIFY=True)
expected = ('<p>This is some content. With some stuff to&nbsp;'
'&#8220;typogrify&#8221;.</p>\n<p>Now with added '
'support for <abbr title="three letter acronym">'
'<span class="caps">TLA</span></abbr>.</p>\n')
self.assertEqual(content, expected)
self.assertEqual(page.content, expected)
except ImportError:
return unittest.skip('need the typogrify distribution')
@ -225,7 +225,7 @@ class MdReaderTest(ReaderTest):
def test_article_with_markdown_markup_extension(self):
# test to ensure the markdown markup extension is being processed as
# expected
content, metadata = self.read_file(
page = self.read_file(
path='article_with_markdown_markup_extensions.md',
MD_EXTENSIONS=['toc', 'codehilite', 'extra'])
expected = ('<div class="toc">\n'
@ -239,11 +239,11 @@ class MdReaderTest(ReaderTest):
'<h2 id="level1">Level1</h2>\n'
'<h3 id="level2">Level2</h3>')
self.assertEqual(content, expected)
self.assertEqual(page.content, expected)
@unittest.skipUnless(readers.Markdown, "markdown isn't installed")
def test_article_with_filename_metadata(self):
content, metadata = self.read_file(
page = self.read_file(
path='2012-11-30_md_w_filename_meta#foo-bar.md',
FILENAME_METADATA=None)
expected = {
@ -251,9 +251,9 @@ class MdReaderTest(ReaderTest):
'author': 'Alexis Métaireau',
}
for key, value in expected.items():
self.assertEqual(value, metadata[key], key)
self.assertEqual(value, page.metadata[key], key)
content, metadata = self.read_file(
page = self.read_file(
path='2012-11-30_md_w_filename_meta#foo-bar.md',
FILENAME_METADATA='(?P<date>\d{4}-\d{2}-\d{2}).*')
expected = {
@ -262,9 +262,9 @@ class MdReaderTest(ReaderTest):
'date': datetime.datetime(2012, 11, 30),
}
for key, value in expected.items():
self.assertEqual(value, metadata[key], key)
self.assertEqual(value, page.metadata[key], key)
content, metadata = self.read_file(
page = self.read_file(
path='2012-11-30_md_w_filename_meta#foo-bar.md',
FILENAME_METADATA=(
'(?P<date>\d{4}-\d{2}-\d{2})'
@ -278,7 +278,7 @@ class MdReaderTest(ReaderTest):
'mymeta': 'foo',
}
for key, value in expected.items():
self.assertEqual(value, metadata[key], key)
self.assertEqual(value, page.metadata[key], key)
class AdReaderTest(ReaderTest):
@ -286,13 +286,13 @@ class AdReaderTest(ReaderTest):
@unittest.skipUnless(readers.asciidoc, "asciidoc isn't installed")
def test_article_with_asc_extension(self):
# Ensure the asc extension is being processed by the correct reader
content, metadata = self.read_file(
page = self.read_file(
path='article_with_asc_extension.asc')
expected = ('<hr>\n<h2><a name="_used_for_pelican_test">'
'</a>Used for pelican test</h2>\n'
'<p>The quick brown fox jumped over'
' the lazy dog&#8217;s back.</p>\n')
self.assertEqual(content, expected)
self.assertEqual(page.content, expected)
expected = {
'category': 'Blog',
'author': 'Author O. Article',
@ -302,7 +302,7 @@ class AdReaderTest(ReaderTest):
}
for key, value in expected.items():
self.assertEqual(value, metadata[key], key)
self.assertEqual(value, page.metadata[key], key)
@unittest.skipUnless(readers.asciidoc, "asciidoc isn't installed")
def test_article_with_asc_options(self):
@ -319,24 +319,24 @@ class AdReaderTest(ReaderTest):
class HTMLReaderTest(ReaderTest):
def test_article_with_comments(self):
content, metadata = self.read_file(path='article_with_comments.html')
page = self.read_file(path='article_with_comments.html')
self.assertEqual('''
Body content
<!-- This comment is included (including extra whitespace) -->
''', content)
''', page.content)
def test_article_with_keywords(self):
content, metadata = self.read_file(path='article_with_keywords.html')
page = self.read_file(path='article_with_keywords.html')
expected = {
'tags': ['foo', 'bar', 'foobar'],
}
for key, value in expected.items():
self.assertEqual(value, metadata[key], key)
self.assertEqual(value, page.metadata[key], key)
def test_article_with_metadata(self):
content, metadata = self.read_file(path='article_with_metadata.html')
page = self.read_file(path='article_with_metadata.html')
expected = {
'category': 'yeah',
'author': 'Alexis Métaireau',
@ -348,21 +348,19 @@ class HTMLReaderTest(ReaderTest):
}
for key, value in expected.items():
self.assertEqual(value, metadata[key], key)
self.assertEqual(value, page.metadata[key], key)
def test_article_with_null_attributes(self):
content, metadata = self.read_file(
path='article_with_null_attributes.html')
page = self.read_file(path='article_with_null_attributes.html')
self.assertEqual('''
Ensure that empty attributes are copied properly.
<input name="test" disabled style="" />
''', content)
''', page.content)
def test_article_metadata_key_lowercase(self):
# Keys of metadata should be lowercase.
content, metadata = self.read_file(
path='article_with_uppercase_metadata.html')
self.assertIn('category', metadata, 'Key should be lowercase.')
self.assertEqual('Yeah', metadata.get('category'),
page = self.read_file(path='article_with_uppercase_metadata.html')
self.assertIn('category', page.metadata, 'Key should be lowercase.')
self.assertEqual('Yeah', page.metadata.get('category'),
'Value keeps cases.')