Merge pull request #27 from cooklang/canonical-metadata

Canonical metadata

Author: Zheoni

CHANGELOG.md

@@ -2,6 +2,24 @@
 
 ## Unreleased - ReleaseDate
 
+- Add support in `cooklang::metadata` for [canonical
+  metadata](https://cooklang.org/docs/spec/#canonical-metadata), making it
+  easier to query these keys and expected values.
+- Add warnings for missused canonical metadata keys.
+- Improve custom checks for metadata keys. Now they can choose to skip the
+  included checks too.
+- Fix ingredients aliases from aisle configuration not being merged in
+  `IngredientList`. (#24 @kaylee-kiako)
+
+## 0.14.0 - 2024/12/11
+
+- Add YAML frontmatter for metadata. Deprecate old style metadata keys with the
+  `>>` syntax. This also comes with changes in the `cooklang::metadata` module.
+- Add deprecation and how to fix warnings when using old style metadata.
+- Remove `MULTILINE_STEPS`, `COMPONENT_NOTE`, `SECTIONS` and `TEXT_STEPS`
+  **extensions** as they are now part of the cooklang specification and are
+  always enabled.
+
 ## 0.13.3 - 2024/08/12
 - Replace `ariadne` dependency with `codesnake`. Because of this, errors may
   have some minor differences.

Cargo.lock

@@ -19,7 +19,6 @@ thiserror = "1"
 url = { version = "2", features = ["serde"] }
 pest = { version = "2", optional = true }
 pest_derive = { version = "2", optional = true }
-emojis = "0.6"
 toml = { version = "0.8", optional = true }
 once_cell = "1"
 enum-map = { version = "2", features = ["serde"] }

Cargo.toml

@@ -174,9 +174,10 @@ <h1>cooklang-rs playground</h1>
 
         <select id="parserSelect">
           <option value="render" selected>Render</option>
-          <option value="full" selected>Full parse</option>
+          <option value="full">Full parse</option>
           <option value="events">Events</option>
           <option value="ast">AST</option>
+          <option value="stdmeta">Standard metadata</option>
         </select>
         <div hidden id="servingscontainer">
           <label for="servings">Servings</label>
@@ -219,7 +220,7 @@ <h1>cooklang-rs playground</h1>
   </main>
 
   <script type="module">
-    import init, { State,version } from "./pkg/cooklang_playground.js";
+    import init, { State, version } from "./pkg/cooklang_playground.js";
 
     async function run() {
       await init();
@@ -286,7 +287,13 @@ <h1>cooklang-rs playground</h1>
             break;
           }
           case "render": {
-            const { value, error } = state.parse_render(input, servings.value.length === 0 ? null : servings.valueAsNumber );
+            const { value, error } = state.parse_render(input, servings.value.length === 0 ? null : servings.valueAsNumber);
+            output.innerHTML = value;
+            errors.innerHTML = error;
+            break;
+          }
+          case "stdmeta": {
+            const { value, error } = state.std_metadata(input);
             output.innerHTML = value;
             errors.innerHTML = error;
             break;
@@ -329,21 +336,19 @@ <h1>cooklang-rs playground</h1>
       servings.addEventListener("change", () => parse());
 
       const extensionsContainer = document.getElementById("extensions-container");
+
       const extensions = [
-        "COMPONENT_MODIFIERS",
-        "COMPONENT_ALIAS",
-        "ADVANCED_UNITS",
-        "MODES",
-        "TEMPERATURE",
-        "RANGE_VALUES",
-        "TIMER_REQUIRES_TIME",
-        "INTERMEDIATE_PREPARATIONS",
-        "SPECIAL_METADATA",
-      ].forEach((e, i) => {
-        let bits = 1 << i;
-        if (i == 11) {
-          bits |= 1 << 1;
-        }
+        ["COMPONENT_MODIFIERS", 1 << 1],
+        ["COMPONENT_ALIAS", 1 << 3],
+        ["ADVANCED_UNITS", 1 << 5],
+        ["MODES", 1 << 6],
+        ["TEMPERATURE", 1 << 7],
+        ["RANGE_VALUES", 1 << 9],
+        ["TIMER_REQUIRES_TIME", 1 << 10],
+        ["INTERMEDIATE_PREPARATIONS", 1 << 11 | 1 << 1]
+      ];
+
+      extensions.forEach(([e, bits]) => {
         const elem = document.createElement("input");
         elem.setAttribute("type", "checkbox");
         elem.setAttribute("id", e);
@@ -414,4 +419,4 @@ <h1>cooklang-rs playground</h1>
   </script>
 </body>
 
-</html>
+</html>

playground/index.html

@@ -1,5 +1,6 @@
 use cooklang::ast::build_ast;
 use cooklang::error::SourceReport;
+use cooklang::metadata::{NameAndUrl, RecipeTime};
 use cooklang::{parser::PullParser, Extensions};
 use cooklang::{Converter, CooklangParser, IngredientReferenceTarget, Item};
 use std::fmt::Write;
@@ -103,6 +104,35 @@ impl State {
         };
         FallibleResult::new(value, report, input)
     }
+
+    pub fn std_metadata(&self, input: &str) -> FallibleResult {
+        let (meta, report) = self.parser.parse_metadata(input).into_tuple();
+        let value = match meta {
+            Some(m) => {
+                #[derive(Debug)]
+                #[allow(dead_code)]
+                struct StdMeta<'a> {
+                    tags: Option<Vec<std::borrow::Cow<'a, str>>>,
+                    author: Option<NameAndUrl>,
+                    source: Option<NameAndUrl>,
+                    time: Option<RecipeTime>,
+                    servings: Option<Vec<u32>>,
+                    locale: Option<(&'a str, Option<&'a str>)>,
+                }
+                let val = StdMeta {
+                    tags: m.tags(),
+                    author: m.author(),
+                    source: m.source(),
+                    time: m.time(self.parser.converter()),
+                    servings: m.servings(),
+                    locale: m.locale(),
+                };
+                format!("{val:#?}")
+            }
+            None => "<no output>".to_string(),
+        };
+        FallibleResult::new(value, report, input)
+    }
 }
 
 impl State {