add support for custom yml format

rande · rande · commit adc91199c89a · 2014-05-02T20:00:57.000-04:00
diff --git a/Makefile b/Makefile
@@ -11,6 +11,7 @@ upload:
 test:
 	nosetests
 	cd element/standalone/skeleton && nosetests
+	cd docs && sphinx-build -nW -b html -d _build/doctrees . _build/html
 
 install:
 	pip install -r requirements_test.txt
@@ -20,7 +21,7 @@ doc:
 	cd docs && sphinx-build -nW -b html -d _build/doctrees . _build/html
 
 dev:
-	cd element/standalone/skeleton && python start.py tornado:start --verbose -d --bind element.vagrant:5000
+	cd element/standalone/skeleton && python start.py tornado:start --verbose -d --bind element.vagrant
 
 prod:
 	cd element/standalone/skeleton && python start.py tornado:start -np 8
diff --git a/docs/managers/filesystem.rst b/docs/managers/filesystem.rst
@@ -1,38 +1,43 @@
-.. note::
-
-    This documentation is under construction, more to come soon
-
-
-
 Filesystem
 ==========
 
 Features
 ~~~~~~~~
 
-  - Insert here the different feature available for this plugin
+  - Load contents from a yaml file
 
 Configuration
 ~~~~~~~~~~~~~
 
-  - Insert the yaml configuration for the DI
+There is no configuration option.
+
+
+Usage
+~~~~~
+
+You can create a yaml file with the following structure:
 
 .. code-block:: yaml
 
-    element.plugins.cache:
-        cache_control:
-            - { "path": "^.*\\.(txt|jpg|png|gif|xls|doc|docx)$",    "Cache-Control": ['public', 's-maxage=14212800']}
-            - { "path": "^(blog|gallery).*",    "Cache-Control": ['public', 's-maxage=3600']}
-            - { "path": "^.*\\.rss",            "Cache-Control": ['public', 's-maxage=3600']}
-            - { "path": "^contact.*",           "Cache-Control": ['private', 'must-revalidate']}
-            - { "path": "^/$",                  "Cache-Control": ['public', 's-maxage=3600']}
+    title: Inline Content
+    type: blog.post
+    tags: ['red', 'yellow']
+
+    ----
+    ## my title
+    Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean rutrum diam
+    lectus, eget ultricies purus. Suspendisse pellentesque enim ullamcorper libero
+    adipiscing vulputate.
 
-Events
-~~~~~~
+    ## section 1
+    Curabitur velit ipsum, sagittis volutpat porta at, imperdiet at risus. Donec ipsum nunc,
+    commodo ut laoreet sed, mollis eu dolor. Praesent iaculis, nisl a laoreet elementum,
+    odio lacus aliquam risus, et aliquam turpis metus vestibulum dolor.
 
- - List event or entry points for this plugin
+    Maecenas venenatis nulla in metus egestas sollicitudin. Donec convallis sodales
+    massa, ac feugiat mauris tincidunt vel. Fusce eu leo vel nisi faucibus luctus.
 
-Architecture
-~~~~~~~~~~~~
 
- - Provide information about how the feature is implemented
+.. note::
+
+    As you notice the file is not a valid yaml file, all the data after the ``----`` separator will be available in the ``content`` field of the node object
diff --git a/element/loaders.py b/element/loaders.py
@@ -1,6 +1,7 @@
-import os, yaml
+import os, yaml, re
 import element
 
+
 class NodeLoader(object):
     pass
 
@@ -41,7 +42,21 @@ def supports(self, path):
         return path[-3:] == 'yml' and os.path.isfile(path)
 
     def load(self, path):
-        return yaml.load(open(path, 'r'))
+        content = open(path, 'r').read()
+
+        data = re.split("\n----\n", content, 2)
+
+        print data, len(data)
+
+        if len(data) > 1:
+            content = data[0]
+
+        node = yaml.load(content)
+
+        if len(data) > 2:
+            node['content'] = data[1]
+
+        return node
 
     def save(self, path, data):
         yaml.safe_dump(data, file(path, 'w'), 
diff --git a/tests/manager/test_fs.py b/tests/manager/test_fs.py
@@ -32,13 +32,14 @@ def tearDown(self):
 
 
     def test_build_references(self):
-        self.assertEquals(4, len(self.fs.files))
+        self.assertEquals(5, len(self.fs.files))
 
         expected = {
             'eacacfab-74cf-6c8d-5e393165': 'feeds',
             '50093cac-fdc1-5ba6-6f12d44e': 'feeds/all.rss',
             'fca0ea55-c21b-186e-fe6924a5': 'sonata_small.png',
-            'c3e6be59-3448-0daa-be2dd043': '2013/my-post-content'
+            'c3e6be59-3448-0daa-be2dd043': '2013/my-post-content',
+            'fa3b5e88-acfb-fc73-90125d9e': '2013/inline-content',
         }
 
         self.assertEquals(expected, self.fs.files)
@@ -70,14 +71,14 @@ def test_exists(self):
 
     def test_find(self):
         cases = [
-            ({}, 4),
-            ({'type': 'blog.post'}, 1),
+            ({}, 5),
+            ({'type': 'blog.post'}, 2),
             ({'type': 'fake'}, 0),
-            ({'type': 'fake', 'types': ['blog.post']}, 1),
-            ({'types': ['blog.post', 'fake']}, 1),
-            ({'types': [], 'tags': ['red', 'yellow']}, 1),
+            ({'type': 'fake', 'types': ['blog.post']}, 2),
+            ({'types': ['blog.post', 'fake']}, 2),
+            ({'types': [], 'tags': ['red', 'yellow']}, 2),
             ({'types': [], 'tags': ['red', 'yellow', 'brown']}, 0),
-            ({'types': [], 'tags': []}, 4)
+            ({'types': [], 'tags': []}, 5)
         ]
 
         for kwarg, expected in cases:
diff --git a/tests/test_loaders.py b/tests/test_loaders.py
@@ -20,6 +20,12 @@ def test_init(self):
 
         self.assertIsNotNone(node['content'])
 
+    def test_load_inline(self):
+        node = self.loader.load("%s/2013/inline-content.yml" % self.path)
+
+
+
+
 class InlineLoaderTest(unittest.TestCase):
 
     def setUp(self):
@@ -38,3 +44,5 @@ def test_load(self):
 
         self.assertEquals('hello', node['type'])
         self.assertEquals('salut', node['id'])
+
+
