<reponame>akashkalal/grow
"""Test the pod collections."""

import unittest
from grow.collections import collection
from grow.translations import locales
from grow.pods import pods
from grow import storage
from grow.testing import testing


class CollectionsTestCase(unittest.TestCase):

    def setUp(self):
        dir_path = testing.create_test_pod_dir()
        self.pod = pods.Pod(dir_path, storage=storage.FileStorage)

    def test_clean_collection_path(self):
        self.assertEqual('pages', collection.Collection.clean_collection_path(
            '/content/pages/'))
        self.assertEqual('pages', collection.Collection.clean_collection_path(
            '/content/pages'))
        self.assertEqual('pages', collection.Collection.clean_collection_path(
            'pages'))
        self.assertEqual('pages/other', collection.Collection.clean_collection_path(
            '/content/pages/other/'))

    def test_get(self):
        col = self.pod.get_collection('/content/pages/')
        self.assertEqual('pages', col.collection_path)
        col2 = self.pod.get_collection('pages')
        docs = col2.docs()
        self.assertEqual(col, col2)
        self.assertEqual(col, docs[0].collection)
        self.assertEqual('pages', docs[0].collection.basename)

    def test_list(self):
        collection.Collection.list(self.pod)

        # Verify empty collection behavior.
        pod = testing.create_pod()
        pod.write_yaml('/podspec.yaml', {})
        pod.write_yaml('/content/col1/_blueprint.yaml', {})
        pod.write_yaml('/content/col2/doc1.yaml', {})
        collection_objs = collection.Collection.list(pod)
        self.assertEqual(['col1'], [col.basename for col in collection_objs])
        pod.write_yaml('/content/col2/_blueprint.yaml', {})
        collection_objs = collection.Collection.list(pod)
        collection_objs.sort(key=lambda col: col.basename)
        self.assertEqual(['col1', 'col2'],
            [col.basename for col in collection_objs])

    def test_order(self):
        pod = testing.create_pod()
        pod.write_yaml('/podspec.yaml', {})
        pod.write_yaml('/content/col-a/_blueprint.yaml', {'$order': 2})
        pod.write_yaml('/content/col-b/_blueprint.yaml', {'$order': 1})
        pod.write_yaml('/content/col-c/_blueprint.yaml', {})
        collection_objs = pod.list_collections()
        expected_sorted = ['col-b', 'col-a', 'col-c']
        collection_objs.sort(key=lambda col: col.order)
        self.assertEqual(
            expected_sorted, [col.basename for col in collection_objs])

    def test_title(self):
        pod = testing.create_pod()
        pod.write_yaml('/podspec.yaml', {})
        pod.write_yaml('/content/pages/_blueprint.yaml', {
            '$title@': 'Base Title',
            '$titles': {
                'nav@': 'Nav Title',
            },
        })
        col = pod.get_collection('pages')
        self.assertEqual('Base Title', col.title)
        self.assertEqual('Base Title', col.titles('none'))
        self.assertEqual('Nav Title', col.titles('nav'))

    def test_docs(self):
        # List documents where locale = fr.
        collection = self.pod.get_collection('pages')
        documents = collection.docs(locale='fr')
        for doc in documents:
            self.assertEqual('fr', doc.locale)

        # Verify list behavior with multi-file localized documents.
        expected_docs = [
            self.pod.get_doc(pod_path, locale='fr')
            for pod_path in [
                '/content/pages/json_test.html',
                '/content/pages/yaml_test.html',
                '/content/pages/home.yaml',
                '/content/pages/intro@fr.md',
                '/content/pages/about.yaml',
                '/content/pages/contact.yaml',
            ]
        ]
        for doc in expected_docs:
            self.assertIn(doc, documents)

        # List unhidden documents.
        documents = collection.docs()
        for doc in documents:
            self.assertFalse(doc.hidden)

        # List all documents.
        documents = collection.docs(include_hidden=True)
        collection = self.pod.get_collection('posts')
        documents = collection.docs(order_by='$published', reverse=True)
        expected = ['newest', 'newer', 'older', 'oldest']
        self.assertListEqual(expected, [doc.base for doc in documents])

    def test_list_locales(self):
        collection = self.pod.get_collection('pages')
        found_locales = collection.locales
        expected = locales.Locale.parse_codes([
            'de',
            'en',
            'fi',
            'fil',
            'fr',
            'it',
        ])
        self.assertListEqual(expected, found_locales)

    def test_list_servable_documents(self):
        collection = self.pod.get_collection('pages')
        collection.list_servable_documents()

    def test_format(self):
        collection = self.pod.get_collection('posts')
        doc = collection.get_doc('/content/posts/newest.md')
        self.assertEqual('# Markdown', doc.body)
        self.assertEqual('<h1 id="markdown">Markdown</h1>', doc.html)

    def test_empty_front_matter(self):
        collection = self.pod.get_collection('empty-front-matter')
        docs = collection.docs()
        path = '/content/empty-front-matter/empty-front-matter.html'
        expected_doc = self.pod.get_doc(path)
        self.assertEqual(expected_doc, docs[0])

    def test_fields(self):
        pod = testing.create_pod()
        pod.write_yaml('/podspec.yaml', {})
        fields = {
            'path': '/{base}/',
            'view': '/views/base.html',
            'user_field': 'foo',
        }
        pod.write_yaml('/content/collection/_blueprint.yaml', fields)
        collection = pod.get_collection('collection')
        self.assertEqual(collection.user_field, 'foo')
        self.assertRaises(AttributeError, lambda: collection.bad_field)

        # Verify backwards-compatible builtin behavior.
        fields = {
            '$path': '/{base}/',
            '$view': '/views/base.html',
        }
        pod.write_yaml('/content/test/_blueprint.yaml', fields)
        pod.write_yaml('/content/test/file.yaml', {})
        doc = pod.get_doc('/content/test/file.yaml')
        self.assertEqual('/file/', doc.get_serving_path())

        fields = {
            'path': '/old/{base}/',
            'view': '/views/base.html',
        }
        pod.write_yaml('/content/old/_blueprint.yaml', fields)
        pod.write_yaml('/content/old/file.yaml', {})
        doc = pod.get_doc('/content/old/file.yaml')
        self.assertEqual('/old/file/', doc.get_serving_path())


    def test_collections(self):
        collection = self.pod.create_collection('new', {})
        self.assertEqual([],
              [col for col in collection.collections()])
        sub_collection = self.pod.create_collection('new/sub', {})
        self.assertEqual([sub_collection],
              [col for col in collection.collections()])
        sub_sub_collection = self.pod.create_collection('new/sub/sub', {})
        self.assertEqual([sub_collection],
              [col for col in collection.collections()])
        self.assertEqual([sub_sub_collection],
              [col for col in sub_collection.collections()])

    def test_nested_collections(self):
        # While it was undefined behavior before, projects relied on the
        # ability to place documents in subfolders inside collections without
        # explicit _blueprint.yaml files inside those folders. Verify that
        # paths are still generated for those documents.
        pod = testing.create_pod()
        pod.write_yaml('/podspec.yaml', {})
        pod.write_file('/views/base.html', '')
        fields = {
            '$path': '/{base}/',
            '$view': '/views/base.html',
        }
        pod.write_yaml('/content/collection/_blueprint.yaml', fields)
        pod.write_yaml('/content/collection/root.yaml', {})
        pod.write_yaml('/content/collection/folder/folder.yaml', {})
        pod.write_yaml(
            '/content/collection/folder/subfolder/subfolder.yaml', {})
        pod.write_yaml(
            '/content/collection/folder2/subfolder2/subfolder2.yaml', {})
        pod.router.add_all(use_cache=False)
        expected = [
            '/root/',
            '/folder/',
            '/subfolder/',
            '/subfolder2/',
        ]
        self.assertItemsEqual(expected, list(pod.router.routes.paths))

        # Blueprints one level deep.
        fields = {
            '$path': '/subfolder-one-level/{base}/',
            '$view': '/views/base.html',
        }
        pod.write_yaml('/content/collection/folder/_blueprint.yaml', fields)
        doc = pod.get_doc('/content/collection/folder/folder.yaml')
        self.assertEqual('/subfolder-one-level/folder/', doc.get_serving_path())

        # Blueprints two levels deep.
        fields = {
            '$path': '/subfolder-two-levels/{base}/',
            '$view': '/views/base.html',
        }
        pod.write_yaml(
            '/content/collection/folder/subfolder/_blueprint.yaml', fields)
        doc = pod.get_doc(
            '/content/collection/folder/subfolder/subfolder.yaml')
        self.assertEqual(
            '/subfolder-two-levels/subfolder/', doc.get_serving_path())

    def test_docs_with_localization(self):
        pod = testing.create_pod()
        fields = {
            'localization': {
                'default_locale': 'en',
                'locales': [
                    'de',
                    'fr',
                    'it',
                ]
            }
        }
        pod.write_yaml('/podspec.yaml', fields)
        fields = {
            '$view': '/views/base.html',
            '$path': '/{base}/',
            'localization': {
                'path': '/{locale}/{base}/',
            }
        }
        pod.write_yaml('/content/pages/_blueprint.yaml', fields)
        pod.write_yaml('/content/pages/foo.yaml', {})
        pod.write_yaml('/content/pages/bar.yaml', {})
        pod.write_yaml('/content/pages/baz.yaml', {})
        pod.write_yaml('/content/pages/foo@de.yaml', {})

        collection = pod.get_collection('pages')
        self.assertEqual(3, len(collection.docs(locale='en')))
        self.assertEqual(3, len(collection.docs(locale='de')))

    def test_create_doc(self):
        pod = testing.create_pod()
        fields = {
            'localization': {
                'default_locale': 'en',
                'locales': [
                    'de',
                ]
            }
        }
        pod.write_yaml('/podspec.yaml', fields)
        fields = {
            '$view': '/views/base.html',
            '$path': '/{base}/',
            'localization': {
                'path': '/{locale}/{base}/',
            }
        }
        pod.write_yaml('/content/pages/_blueprint.yaml', fields)
        pod_collection = pod.get_collection('pages')
        pod_collection.create_doc('/content/pages/foo.yaml', {
            'testing': 'bananas',
        })
        doc = pod.get_doc('/content/pages/foo.yaml')
        self.assertEqual('bananas', doc.testing)

    def test_owns_doc_at_path(self):
        pod = testing.create_pod()
        pod.write_yaml('/podspec.yaml', {})
        pod.write_yaml('/content/pages/_blueprint.yaml', {})
        pod.write_yaml('/content/pages/page.yaml', {})
        pod.write_yaml('/content/pages/owned/page.yaml', {})
        pod.write_yaml('/content/pages/owned/deeper/page.yaml', {})
        pod.write_yaml('/content/pages/sub/_blueprint.yaml', {})
        pod.write_yaml('/content/pages/sub/page.yaml', {})
        pod.write_yaml('/content/pages/sub/owned/page.yaml', {})
        pod.write_yaml('/content/pages/sub/sub/_blueprint.yaml', {})
        pod.write_yaml('/content/pages/sub/sub/page.yaml', {})
        col = pod.get_collection('/content/pages')
        self.assertTrue(col._owns_doc_at_path('/content/pages/page.yaml'))
        self.assertTrue(col._owns_doc_at_path('/content/pages/owned/page.yaml'))
        self.assertTrue(col._owns_doc_at_path('/content/pages/owned/deeper/page.yaml'))
        self.assertFalse(col._owns_doc_at_path('/content/pages/sub/page.yaml'))
        self.assertFalse(col._owns_doc_at_path('/content/pages/sub/owned/page.yaml'))
        sub_col = pod.get_collection('/content/pages/sub')
        self.assertTrue(sub_col._owns_doc_at_path('/content/pages/sub/page.yaml'))
        self.assertTrue(sub_col._owns_doc_at_path('/content/pages/sub/owned/page.yaml'))
        self.assertFalse(sub_col._owns_doc_at_path('/content/pages/sub/sub/page.yaml'))


if __name__ == '__main__':
    unittest.main()
