Allow .yml extension (#169)

Author: tbrlpld

CHANGELOG.md

@@ -13,6 +13,7 @@
 
 - Change Poetry version to be `>=1.1.12,<2` in Docker development setup (prevents `JSONDecodeError` issue under Python 3.10) ([#178](https://github.com/torchbox/django-pattern-library/pull/178)).
 - Move demo/test app pattern-library from `/pattern-library/` to `/` ([#178](https://github.com/torchbox/django-pattern-library/pull/178)).
+- Allow `.yml` extension for YAML files ([#161](https://github.com/torchbox/django-pattern-library/issues/161)).
 
 ### Removed
 

docs/getting-started.md

@@ -168,7 +168,7 @@ We additionally need to customize a base template, so the standalone component c
 
 ### Component data
 
-We can provide context and tags overrides for our new component by creating a `quote_block.yaml` YAML file alongside the HTML, at `patterns/components/quote_block/quote_block.yaml` in our example.
+We can provide context and tags overrides for our new component by creating a `quote_block.yaml` YAML file alongside the HTML, at `patterns/components/quote_block/quote_block.yaml` in our example. You can use either `.yaml` or `.yml` as the file extension.
 
 ```yaml
 context:

docs/reference/api.md

@@ -6,7 +6,7 @@ YAML isn’t everyone’s favorite markup language, but it has the advantage of
 
 Here is what you need to know:
 
-- Always use `.yaml` for patterns configuration.
+- Use `.yaml` or `.yml` as the file extension for pattern configuration files. If both are present, the `.yaml` file takes precendence.
 - Use Mappings in place of Python Dictionaries.
 - Use Sequences in place of Python lists (or iterables like QuerySets).
 - The pattern library uses [PyYAML](https://pyyaml.org/wiki/PyYAMLDocumentation) in particular

pattern_library/utils.py

@@ -149,7 +149,11 @@ def get_pattern_config_str(template_name):
     try:
         context_file = get_template(context_name)
     except TemplateDoesNotExist:
-        return ''
+        context_name = context_path + '.yml'
+        try:
+            context_file = get_template(context_name)
+        except TemplateDoesNotExist:
+            return ''
 
     return context_file.render()
 

tests/templates/patterns/atoms/test_atom_yml/test_atom_yml.html

@@ -0,0 +1 @@
+{{ atom_var }}

tests/templates/patterns/atoms/test_atom_yml/test_atom_yml.yml

@@ -0,0 +1,2 @@
+context:
+  atom_var: 'atom_var value from test_atom.yml (notice the missing "a" in the extension)'

tests/tests/test_utils.py

@@ -3,7 +3,9 @@
 from django.conf import settings
 from django.test import SimpleTestCase, override_settings
 
-from pattern_library.utils import get_template_ancestors, get_template_dirs
+from pattern_library.utils import (
+    get_pattern_config_str, get_template_ancestors, get_template_dirs
+)
 
 
 class TestGetTemplateAncestors(SimpleTestCase):
@@ -79,3 +81,22 @@ def test_get_template_dirs_list_dirs(self):
             'dpl/pattern_library',
             'dpl/tests',
         ])
+
+
+class TestGetPatternConfigStr(SimpleTestCase):
+    def test_not_existing_template(self):
+        result = get_pattern_config_str("doesnotexist")
+
+        self.assertEqual(result, "")
+
+    def test_atom_yaml(self):
+        result = get_pattern_config_str("patterns/atoms/test_atom/test_atom.html")
+
+        self.assertNotEqual(result, "")
+        self.assertIn("atom_var value from test_atom.yaml", result)
+
+    def test_atom_yml(self):
+        result = get_pattern_config_str("patterns/atoms/test_atom_yml/test_atom_yml.html")
+
+        self.assertNotEqual(result, "")
+        self.assertIn("atom_var value from test_atom.yml", result)