Use a git submodule for the mustache spec tests

- Bump Mustache spec support from 1.4.1 to 1.4.2
- Update readme to reflect changes

Author: JamyGolden

.github/workflows/msrv.yml

@@ -17,6 +17,8 @@ jobs:
     steps:
       - name: Fetch Repository
         uses: actions/checkout@v4
+        with:
+          submodules: true
 
       - name: Install stable toolchain
         uses: actions-rust-lang/setup-rust-toolchain@v1
@@ -50,6 +52,8 @@ jobs:
     steps:
       - name: Fetch Repository
         uses: actions/checkout@v4
+        with:
+          submodules: true
 
       - run: git pull
 

.github/workflows/test.yml

@@ -15,7 +15,10 @@ jobs:
     name: Test
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - name: Checkout repo and submodules
+        uses: actions/checkout@v4
+        with:
+          submodules: true
       - uses: actions-rust-lang/setup-rust-toolchain@v1
       - uses: actions/cache@v4
         with:

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "ribboncurls/vendor/github.com/mustache/spec"]
+	path = ribboncurls/vendor/github.com/mustache/spec
+	url = https://github.com/mustache/spec.git

Makefile

@@ -10,13 +10,15 @@ test_cli: build
 	@echo "Running cli tests and lint"
 	@echo "--------------------------"
 	cargo fmt -p ribboncurls-cli --check || { echo "Formatting check failed"; exit 1; }
+	git submodule update --init
 	cargo test -p ribboncurls-cli --release
 
 test_lib: build
 	@echo "--------------------------"
 	@echo "Running lib tests and lint"
 	@echo "--------------------------"
 	cargo fmt -p ribboncurls --check || { echo "Formatting check failed"; exit 1; }
+	git submodule update --init
 	cargo test -p ribboncurls --release
 
 build: install

README.md

@@ -12,154 +12,37 @@
 
 Ribboncurls is a [Mustache] template rendering engine written in [Rust].
 
-There is both a Rust [Ribboncurls library] and [Ribboncurls CLI tool], depending
-on your needs. You can read more about those specific projects in their
-respective README.md files.
+There is both a Rust [Ribboncurls library] and [Ribboncurls CLI tool],
+depending on your needs. You can read more about those specific projects
+in their respective README.md files.
 
 **Note**: Ribboncurls library public API is subject to change, so use
 with caution.
 
-## Mustache spec tests
-
-We run the [mustache spec tests] against the Ribboncurls lib and we are
-passing all 133 of 133 tests.
-
-<details><summary>Tests</summary>
-✅ comments::inline<br>
-✅ comments::standalone<br>
-✅ comments::multiline_standalone<br>
-✅ comments::variable_name_collision<br>
-✅ comments::multiline<br>
-✅ comments::indented_inline<br>
-✅ comments::indented_standalone<br>
-✅ comments::indented_multiline_standalone<br>
-✅ comments::surrounding_whitespace<br>
-✅ comments::standalone_line_endings<br>
-✅ comments::standalone_without_previous_line<br>
-✅ comments::standalone_without_newline<br>
-✅ delimiters::pair_behavior<br>
-✅ delimiters::pair_with_padding<br>
-✅ delimiters::indented_standalone_tag<br>
-✅ delimiters::outlying_whitespace_inline<br>
-✅ delimiters::special_characters<br>
-✅ delimiters::standalone_tag<br>
-✅ interpolation::ampersand_context_miss_interpolation<br>
-✅ delimiters::surrounding_whitespace<br>
-✅ delimiters::standalone_without_newline<br>
-✅ delimiters::standalone_without_previous_line<br>
-✅ interpolation::ampersand<br>
-✅ delimiters::inverted_sections<br>
-✅ delimiters::standalone_line_endings<br>
-✅ delimiters::post_partial_behavior<br>
-✅ interpolation::ampersand_integer_interpolation<br>
-✅ delimiters::sections<br>
-✅ interpolation::ampersand_standalone<br>
-✅ interpolation::ampersand_decimal_interpolation<br>
-✅ interpolation::ampersand_with_padding<br>
-✅ interpolation::ampersand_null_interpolation<br>
-✅ interpolation::basic_context_miss_interpolation<br>
-✅ interpolation::ampersand_surrounding_whitespace<br>
-✅ interpolation::basic_null_interpolation<br>
-✅ interpolation::dotted_names_broken_chain_resolution<br>
-✅ interpolation::basic_decimal_interpolation<br>
-✅ interpolation::basic_integer_interpolation<br>
-✅ interpolation::dotted_names_arbitrary_depth<br>
-✅ interpolation::dotted_names_broken_chains<br>
-✅ interpolation::dotted_names_ampersand_interpolation<br>
-✅ interpolation::basic_interpolation<br>
-✅ delimiters::partial_inheritence<br>
-✅ interpolation::dotted_names_basic_interpolation<br>
-✅ interpolation::dotted_names_context_precedence<br>
-✅ interpolation::implicit_iterators_basic_integer_interpolation<br>
-✅ interpolation::html_escaping<br>
-✅ interpolation::dotted_names_initial_resolution<br>
-✅ interpolation::implicit_iterators_triple_mustache<br>
-✅ interpolation::interpolation_surrounding_whitespace<br>
-✅ interpolation::implicit_iterators_ampersand<br>
-✅ interpolation::dotted_names_triple_mustache_interpolation<br>
-✅ interpolation::interpolation_standalone<br>
-✅ interpolation::implicit_iterators_basic_interpolation<br>
-✅ interpolation::interpolation_with_padding<br>
-✅ interpolation::implicit_iterators_html_escaping<br>
-✅ interpolation::triple_mustache<br>
-✅ interpolation::no_interpolation<br>
-✅ interpolation::triple_mustache_surrounding_whitespace<br>
-✅ interpolation::triple_mustache_context_miss_interpolation<br>
-✅ interpolation::triple_mustache_standalone<br>
-✅ interpolation::triple_mustache_integer_interpolation<br>
-✅ interpolation::triple_mustache_null_interpolation<br>
-✅ interpolation::triple_mustache_with_padding<br>
-✅ interpolation::triple_mustache_decimal_interpolation<br>
-✅ inverted::context_misses<br>
-✅ inverted::context<br>
-✅ inverted::dotted_names_truthy<br>
-✅ inverted::falsey<br>
-✅ inverted::dotted_names_broken_chains<br>
-✅ inverted::empty_list<br>
-✅ inverted::dotted_names_falsey<br>
-✅ inverted::list<br>
-✅ inverted::doubled<br>
-✅ inverted::indented_inline_sections<br>
-✅ inverted::internal_whitespace<br>
-✅ inverted::nested_falsey<br>
-✅ inverted::padding<br>
-✅ inverted::null_is_falsey<br>
-✅ inverted::standalone_line_endings<br>
-✅ inverted::standalone_indented_lines<br>
-✅ inverted::nested_truthy<br>
-✅ inverted::standalone_lines<br>
-✅ inverted::truthy<br>
-✅ inverted::standalone_without_previous_line<br>
-✅ partials::failed_lookup<br>
-✅ inverted::standalone_without_newline<br>
-✅ inverted::surrounding_whitespace<br>
-✅ partials::standalone_without_previous_line<br>
-✅ partials::basic_behavior<br>
-✅ partials::context<br>
-✅ partials::padding_whitespace<br>
-✅ partials::inline_indentation<br>
-✅ sections::dotted_names_broken_chains<br>
-✅ sections::dotted_names_falsey<br>
-✅ partials::standalone_line_endings<br>
-✅ partials::standalone_indentation<br>
-✅ partials::nested<br>
-✅ partials::surrounding_whitespace<br>
-✅ sections::dotted_names_truthy<br>
-✅ partials::standalone_without_newline<br>
-✅ partials::recursion<br>
-✅ sections::context<br>
-✅ sections::empty_list<br>
-✅ sections::falsey<br>
-✅ sections::context_misses<br>
-✅ sections::doubled<br>
-✅ sections::implicit_iterator_html_escaping<br>
-✅ sections::implicit_iterator_decimal<br>
-✅ sections::implicit_iterator_root_level<br>
-✅ sections::implicit_iterator_ampersand<br>
-✅ sections::implicit_iterator_string<br>
-✅ sections::implicit_iterator_integer<br>
-✅ sections::implicit_iterator_array<br>
-✅ sections::indented_standalone_lines<br>
-✅ sections::implicit_iterator_triple_mustache<br>
-✅ sections::list<br>
-✅ sections::indented_inline_sections<br>
-✅ sections::internal_whitespace<br>
-✅ sections::padding<br>
-✅ sections::deeply_nested_contexts<br>
-✅ sections::standalone_lines<br>
-✅ sections::nested_falsey<br>
-✅ sections::parent_contexts<br>
-✅ sections::standalone_line_endings<br>
-✅ sections::null_is_falsey<br>
-✅ sections::list_contexts<br>
-✅ sections::standalone_without_newline<br>
-✅ sections::surrounding_whitespace<br>
-✅ sections::nested_truthy<br>
-✅ sections::variable_test<br>
-✅ sections::truthy<br>
-✅ sections::standalone_without_previous_line<br>
-</details>
-
+## Features
+
+Ribboncurls supports all the required Mustache features as per [Mustache
+spec] and runs against the [Mustache v1.4.2 spec] tests.
+
+- [x] Comments: `12345{{! Comment Block! }}67890`
+- [x] Delimiters: Change delimiters from `{{ }}` to your own custom
+  delimiters
+  - `{{=<% %>=}}(<%text%>)`
+- [x] Interpolation 
+  - `{{text}}` - Renders escaped variable `text`
+  - `{{&text}}`, `{{{text}}}` - Renders variable `text` without
+    escaping
+  - `{{a.b.c.d}}` - Renders HashMap properties
+  - and more
+- [x] Sections 
+  - `{{#text}}Renders when text exists{{/text}}` - Renders section
+    when `text` is truthy
+  - `{{#animals_array}}({{.}}){{/list}}` - Implicit iterator
+- [x] Inverted: Functionally serves as inverted sections
+  - `{{^text}}Renders when text does not exist{{/text}}`
+- [x] Partials: Used to expand an external template into the current
+  template
+  - `{{>partial_property}}`
 
 ## Code of Conduct
 
@@ -182,4 +65,5 @@ license. See the [THIRD_PARTY_LICENSES] file for details.
 [MPL-2.0]: LICENSE
 [Code of Conduct]: https://github.com/tinted-theming/home/blob/main/CODE_OF_CONDUCT.md
 [THIRD_PARTY_LICENSES]: THIRD_PARTY_LICENSES.md
-[mustache spec tests]: https://github.com/mustache/spec
+[Mustache spec]: https://github.com/mustache/spec
+[mustache v1.4.2 spec]: https://github.com/mustache/spec/tree/v1.4.2

ribboncurls/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+## Added
+
+- Bump support from Mustache spec 1.4.1 to 1.4.2
+
 ## Fixed
 
 - Remove unintended stdout prints.