def test_recipes_split_across_blocks(self) -> None:
compiled = compile_markdown(
dedent("""
A recipe in two parts. Part one:
sauce = boil down(tomatoes, water)
Part two:
pour over(pasta, sauce)
""").strip())
sr = SubRecipe(
Step(
SVS("boil down"),
(
Ingredient(SVS("tomatoes")),
Ingredient(SVS("water")),
),
),
(SVS("sauce"), ),
)
r1 = Recipe((sr, ))
r2 = Recipe(
(Step(
SVS("pour over"),
(
Ingredient(SVS("pasta")),
Reference(sr),
),
), ),
follows=r1,
)
assert compiled.recipes == [[r1, r2]]
def test_separate_recipes(self) -> None:
compiled = compile_markdown(
dedent("""
Fried egg:
```recipe
1 egg
```
```recipe
fry(egg)
```
Boiled egg:
```new-recipe
2 egg
```
```recipe
boil(egg)
```
""").strip())
e1 = SubRecipe(
Ingredient(SVS("egg"), Quantity(1)),
(SVS("egg"), ),
show_output_names=False,
)
r1 = Recipe((e1, ))
r2 = Recipe((Step(SVS("fry"), (Reference(e1), )), ), follows=r1)
e2 = SubRecipe(
Ingredient(SVS("egg"), Quantity(2)),
(SVS("egg"), ),
show_output_names=False,
)
r3 = Recipe((e2, ))
r4 = Recipe((Step(SVS("boil"), (Reference(e2), )), ), follows=r3)
assert compiled.recipes == [[r1, r2], [r3, r4]]
# Check anchor IDs are unique too
html = compiled.render()
assert 'id="recipe-egg"' in html
assert 'href="#recipe-egg"' in html
assert 'id="recipe2-egg"' in html
assert 'href="#recipe2-egg"' in html
def test_reference_compilation(self) -> None:
sub_recipe = SubRecipe(
Step(SVS("open"), (Ingredient(SVS("spam")), )),
(SVS("spam"), SVS("tin")),
True,
)
assert compile([
"spam, tin = open(spam)\nspam\n1/3*spam\n25% of the spam\nleft over spam\n2 'tin'\n50g spam" # noqa: E501
]) == [
Recipe((
sub_recipe,
# spam
Reference(sub_recipe, 0, Proportion(1.0)),
# 1/3*spam
Reference(sub_recipe, 0,
Proportion(Fraction(1, 3), preposition="*")),
# 25% of the spam
Reference(
sub_recipe,
0,
Proportion(0.25, percentage=True, preposition="% of the"),
),
# remaining
Reference(sub_recipe, 0,
Proportion(None, remainder_wording="left over")),
# 2 tin
Reference(sub_recipe, 1, Quantity(2.0)),
# 50g spam
Reference(sub_recipe, 0, Quantity(50.0, "g")),
)),
]
def test_ingredient_with_explicit_output_name_always_shown(
self, output_name: str) -> None:
# NB: output name always shown even if it matches what would be the inferred name
assert compile([f"{output_name} = spam"]) == [
Recipe((SubRecipe(Ingredient(SVS("spam")), (SVS(output_name), ),
True), ))
]
def test_nested_reference_to_sub_recipe_not_in_recipe(self) -> None:
external_sr = SubRecipe(Ingredient(SVS("eggs")), (SVS("foo"), ))
ref = Reference(external_sr)
step = Step(SVS("bar"), (ref, ))
with pytest.raises(ReferenceToInvalidSubRecipeError):
Recipe((step, ))
def test_reference_to_nested_sub_recipe(self) -> None:
nested_sr = SubRecipe(Ingredient(SVS("eggs")), (SVS("foo"), ))
step = Step(SVS("scramble"), (nested_sr, ))
ref = Reference(nested_sr)
with pytest.raises(ReferenceToInvalidSubRecipeError):
Recipe((step, ref))
def test_reference_has_no_inferred_name(self) -> None:
sub_recipe = SubRecipe(Ingredient(SVS("spam")), (SVS("spam"), ), False)
assert compile(["spam\nspam\nspam"]) == [
Recipe((
sub_recipe,
Reference(sub_recipe, 0),
Reference(sub_recipe, 0),
)),
]
def test_processed_ingredient_with_implied_output_name(
self, syntax: str) -> None:
assert compile([syntax]) == [
Recipe((SubRecipe(
Step(SVS("fry"), (Ingredient(SVS("spam")), )),
(SVS("spam"), ),
False,
), )),
]
def test_inlining_within_a_block(self) -> None:
recipe0 = Recipe((SubRecipe(Ingredient(SVS("egg")), (SVS("egg"), ),
show_output_names=False), ))
recipe1 = Recipe(
(Step(SVS("fry"),
(Ingredient(SVS("spam"), Quantity(50, "g")), )), ),
follows=recipe0,
)
recipe2 = Recipe(
(SubRecipe(Ingredient(SVS("potato")), (SVS("potato"), ),
show_output_names=False), ),
follows=recipe1,
)
assert compile(["egg", "50g spam\nfry(spam)", "potato"]) == [
recipe0,
recipe1,
recipe2,
]
def test_string_compilation(self) -> None:
# Just a sanity check
assert compile(["spam {3 eggs}"]) == [
Recipe((SubRecipe(
Ingredient(SVS(("spam ", 3, " eggs"))),
(SVS(["spam ", 3, " eggs"]), ),
False,
), ))
]
def test_dont_inline_definitions_from_earlier_blocks(self) -> None:
sub_recipe = SubRecipe(
Ingredient(SVS("spam"), Quantity(100, "g")),
(SVS("spam"), ),
False,
)
recipe0 = Recipe((sub_recipe, ))
recipe1 = Recipe(
(Step(
SVS("fry"),
(
Reference(sub_recipe, 0, Quantity(50, "g")),
Ingredient(SVS("eggs")),
),
), ),
follows=recipe0,
)
assert compile(["100g spam",
"fry(50g spam, eggs)"]) == [recipe0, recipe1]
def test_valid_references(self) -> None:
sr = SubRecipe(Ingredient(SVS("eggs")), (SVS("foo"), ))
ref1 = Reference(sr)
# Shouldn't fail
rec1 = Recipe((sr, ref1))
# Also shouldn't fail (since marked as follows)
ref2 = Reference(sr)
rec2 = Recipe((ref2, ), follows=rec1)
# Chained references
ref3 = Reference(sr)
Recipe((ref3, ), follows=rec2)
# Should fail: not referenced
ref4 = Reference(sr)
with pytest.raises(ReferenceToInvalidSubRecipeError):
Recipe((ref4, ))
def test_compilation_of_steps(self) -> None:
assert compile(["fry(slice(spam), eggs)"]) == [
Recipe((Step(
SVS("fry"),
(
Step(SVS("slice"), (Ingredient(SVS("spam")), )),
Ingredient(SVS("eggs")),
),
), )),
]
def test_inlining_single_references_name_explicitly_required(self) -> None:
assert compile(["meat := spam, sliced\nfry(meat, eggs)"]) == [
Recipe((Step(
SVS("fry"),
(
SubRecipe(
Step(SVS("sliced"), (Ingredient(SVS("spam")), )),
(SVS("meat"), ),
),
Ingredient(SVS("eggs")),
),
), ))
]
def test_scale(self) -> None:
sr_2 = SubRecipe(Ingredient(SVS("spam"), Quantity(2)), (SVS("spam"), ))
ref_sr_2 = Reference(sr_2)
sr_6 = SubRecipe(Ingredient(SVS("spam"), Quantity(6)), (SVS("spam"), ))
ref_sr_6 = Reference(sr_6)
first_rec_2 = Recipe((sr_2, ))
second_rec_2 = Recipe((ref_sr_2, ), follows=first_rec_2)
first_rec_6 = Recipe((sr_6, ))
second_rec_6 = Recipe((ref_sr_6, ), follows=first_rec_6)
assert first_rec_2.scale(3) == first_rec_6
assert second_rec_2.scale(3) == second_rec_6
def test_inlining_single_references(self, quantity_spec: str) -> None:
assert compile(
[f"meat = 10g spam, sliced\nfry({quantity_spec} meat, eggs)"]) == [
Recipe((Step(
SVS("fry"),
(
Step(
SVS("sliced"),
(Ingredient(SVS("spam"), Quantity(10, "g")), ),
),
Ingredient(SVS("eggs")),
),
), ))
]
def test_inlines_within_inlines(self) -> None:
recipe = Recipe((Step(
SVS("boil"),
(
SubRecipe(
Step(
SVS("fry"),
(Ingredient(SVS("spam"), Quantity(100, "g")), ),
),
(SVS("fried spam"), ),
),
Ingredient(SVS("water")),
),
), ))
assert compile([
"100g spam\nfried spam := fry(spam)\nboil(fried spam, water)"
]) == [recipe]
def test_dont_inline_partial_uses_of_a_subrecipe(self) -> None:
sub_recipe = SubRecipe(
Ingredient(SVS("spam"), Quantity(100, "g")),
(SVS("spam"), ),
False,
)
assert compile(["100g spam\nfry(50g spam, eggs)"]) == [
Recipe((
sub_recipe,
Step(
SVS("fry"),
(
Reference(sub_recipe, 0, Quantity(50, "g")),
Ingredient(SVS("eggs")),
),
),
))
]
def test_dont_inline_multi_output_subrecipes(self) -> None:
sub_recipe = SubRecipe(
Ingredient(SVS("spam")),
(SVS("meat"), SVS("tin")),
True,
)
assert compile(["meat, tin = spam\nfry(meat, eggs)"]) == [
Recipe((
sub_recipe,
Step(
SVS("fry"),
(
Reference(sub_recipe, 0),
Ingredient(SVS("eggs")),
),
),
))
]
def test_ingredient_compilation(self) -> None:
assert compile(
["500g spam\n2 eggs\n1 kg foo\n1 can of dog food\nheat"]) == [
Recipe((
# With unit
SubRecipe(
Ingredient(SVS("spam"), Quantity(500.0, "g")),
(SVS("spam"), ),
False,
),
# No unit
SubRecipe(
Ingredient(SVS("eggs"), Quantity(2.0)),
(SVS("eggs"), ),
False,
),
# With spacing between number and unit
SubRecipe(
Ingredient(SVS("foo"),
Quantity(1.0, "kg",
value_unit_spacing=" ")),
(SVS("foo"), ),
False,
),
# With spacing between number and unit
SubRecipe(
Ingredient(
SVS("dog food"),
Quantity(
1,
"can",
value_unit_spacing=" ",
preposition=" of",
),
),
(SVS("dog food"), ),
False,
),
# No quantity
SubRecipe(Ingredient(SVS("heat")), (SVS("heat"), ), False),
))
]
def test_recipe_code_blocks_and_scaled_rendering(self,
source: str) -> None:
compiled = compile_markdown(dedent(source).strip())
assert compiled.title == "A recipe"
assert compiled.servings == 2
assert compiled.recipes == [[
Recipe((Step(
SVS("fry"),
(
Ingredient(SVS("spam"), Quantity(100, "g")),
Ingredient(SVS("eggs"), Quantity(2)),
),
), )),
]]
assert (compiled.render(2) == dedent("""
<header><h1 class="rg-title-scalable">A recipe <span class="rg-serving-count">for <span class="rg-scaled-value">4</span></span></h1><p>Rescaled from <span class="rg-original-servings">2 servings</span>.</p></header>
<div class="rg-recipe-block">
<table class="rg-table">
<tr>
<td class="rg-ingredient rg-border-left-sub-recipe rg-border-top-sub-recipe">
<span class="rg-quantity-with-conversions rg-scaled-value" tabindex="0">
200g<ul class="rg-quantity-conversions">
<li><sup>1</sup>⁄<sub>5</sub>kg</li>
<li>0.441lb</li>
<li>7.05oz</li>
</ul>
</span> spam
</td>
<td class="rg-step rg-border-right-sub-recipe rg-border-top-sub-recipe rg-border-bottom-sub-recipe" rowspan="2">fry</td>
</tr>
<tr><td class="rg-ingredient rg-border-left-sub-recipe rg-border-bottom-sub-recipe"><span class="rg-quantity-unitless rg-scaled-value">4</span> eggs</td></tr>
</table>
</div><p>Ta-da!</p>
"""
# noqa: E501
).lstrip())
def test_reference_to_sub_recipe_later_in_recipe(self) -> None:
later_sr = SubRecipe(Ingredient(SVS("eggs")), (SVS("foo"), ))
ref = Reference(later_sr)
with pytest.raises(ReferenceToInvalidSubRecipeError):
Recipe((ref, later_sr))
def compile(self, sources: List[str]) -> List[Recipe]:
"""
Compile a series of recipe parse trees
(:py:class:`recipe_grid.ast.Recipe`) into a series of
:py:class:`Recipe` structures where each structure represents a
particular block in the input recipe specification.
"""
self._sources = sources
self._named_outputs = OrderedDict()
ast_recipes = [parse(source) for source in self._sources]
recipe_block_recipe_trees: List[List[RecipeTreeNode]] = []
for recipe_index, ast_recipe in enumerate(ast_recipes):
self._current_recipe_index = recipe_index
recipe_trees: List[RecipeTreeNode] = []
for ast_stmt in ast_recipe.stmts:
recipe_trees.append(self._compile_stmt(ast_stmt))
recipe_block_recipe_trees.append(recipe_trees)
# Move SubRecipes inline where possible
for named_output in self._named_outputs.values():
if named_output.can_be_inlined:
# Unwrap the to-be-inlined SubTree if needed
tree_to_inline: RecipeTreeNode
if named_output.unwrap_subrecipe_when_inlined:
tree_to_inline = named_output.sub_recipe.sub_tree
else:
tree_to_inline = named_output.sub_recipe
definition_to_remove = named_output.sub_recipe
reference_to_replace = named_output.references[0][0]
# Remove the original definition
recipe_trees = recipe_block_recipe_trees[
named_output.definition_recipe_index]
recipe_trees.remove(definition_to_remove)
# Apply inline-substitution
recipe_block_recipe_trees = [[
recipe_tree.substitute(reference_to_replace,
tree_to_inline)
for recipe_tree in recipe_trees
] for recipe_trees in recipe_block_recipe_trees]
# Inline-substitution also applied to recipe trees contained in
# NamedOutputs since otherwise when attempting to inline based
# on these out-of-date trees would be found.
for other_named_output in self._named_outputs.values():
other_named_output.substitute(reference_to_replace,
tree_to_inline)
# Create recipe objects
previous_recipe = None
out: List[Recipe] = []
for recipe_trees in recipe_block_recipe_trees:
recipe = Recipe(tuple(recipe_trees), previous_recipe)
out.append(recipe)
previous_recipe = recipe
return out
def test_ingredient_with_implied_output_name(self) -> None:
assert compile(["spam"]) == [
Recipe((SubRecipe(Ingredient(SVS("spam")), (SVS("spam"), ),
False), ))
]
def test_multiple_outputs(self) -> None:
assert compile(["foo, bar = spam"]) == [
Recipe((SubRecipe(Ingredient(SVS("spam")),
(SVS("foo"), SVS("bar")), True), ))
]
def test_step_with_multiple_inputs_has_no_inferred_name(self) -> None:
assert compile(["fry(spam, eggs)"]) == [
Recipe(
(Step(SVS("fry"),
(Ingredient(SVS("spam")), Ingredient(SVS("eggs")))), )),
]