Skip to content

test(mudblazor): let every item-form builder configure its collection (#300) #327

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
phmatray merged 7 commits into from
Aug 13, 2026
Merged

test(mudblazor): let every item-form builder configure its collection (#300) #327

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
3306ed7
chore(#300): scaffold draft PR for configureCollection on every item-…
phmatray Aug 13, 2026
5247969
test(mudblazor): let every item-form builder configure its collection
phmatray Aug 13, 2026
50655dc
test(mudblazor): give the root-field builder a collection callback
phmatray Aug 13, 2026
cef80da
test(mudblazor): build the characterisation suite's order form from t…
phmatray Aug 13, 2026
93f9a7c
Merge remote-tracking branch 'origin/dev' into feat/300-configurecoll…
phmatray Aug 13, 2026
910723d
test(mudblazor): pin the collection callback's invoke order and docum…
phmatray Aug 13, 2026
63b40bb
Merge remote-tracking branch 'origin/dev' into feat/300-configurecoll…
phmatray Aug 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 29 additions & 27 deletions FormCraft.ForMudBlazor.UnitTests/Components/CollectionRenderCharacterisationTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -371,34 +371,36 @@ private IRenderedComponent<FormCraftComponent<OrderModel>> RenderOrderForm(
bool allowAdd = false,
bool allowRemove = false)
{
var config = FormBuilder<OrderModel>
.Create()
.AddCollectionField(x => x.Items, collection =>
// The label and the one-string-field item form are byte-identical to TextItemForm's, so the
// only thing this suite varies is the three flags — and configureCollection (#300) is how a
// caller reaches settings that belong to the collection rather than to a field.
//
// They stay CONDITIONAL. Applying them unconditionally would render an Add button on every
// call, and the sibling tests locate it with FindComponent<MudButton>(), which throws when
// it is absent and matches a newly-rendered one when it is not expected — so the flags are
// load-bearing for what those tests assert, not just for what this helper builds.
var config = TextItemForm(configureCollection: collection =>
{
if (allowReorder)
{
collection.AllowReorder();
}

if (allowAdd)
{
collection.WithLabel("Items");
if (allowReorder)
{
collection.AllowReorder();
}

if (allowAdd)
{
collection.AllowAdd();
}

if (allowRemove)
{
collection.AllowRemove();
}

collection.WithItemForm(item => item
.AddField(x => x.ProductName, field => field.WithLabel("Product")));
})
.Build();

return Render<FormCraftComponent<OrderModel>>(parameters => parameters
.Add(p => p.Model, model)
.Add(p => p.Configuration, config));
collection.AllowAdd();
}

if (allowRemove)
{
collection.AllowRemove();
}
});

// ...and the render goes through the fixture's own helper too, which is the rest of "built
// from the fixture": this was the last hand-rolled Model/Configuration wiring in a suite
// that already calls RenderItemForm everywhere else.
return this.RenderItemForm(model, config);
}

/// <summary>
Expand Down
203 changes: 142 additions & 61 deletions FormCraft.ForMudBlazor.UnitTests/Fields/CollectionItemFixture.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,24 @@ namespace FormCraft.ForMudBlazor.UnitTests.Fields;
/// </para>
/// <para>
/// Models are deliberately dumb and stable — no behaviour, no validation attributes, no computed
/// members. Everything a suite wants to vary goes through the <c>configure</c> callback on the item-form
/// builders instead, so a change here cannot ripple into what an unrelated suite asserts.
/// members. Everything a suite wants to vary goes through a callback on the item-form builders
/// instead, so a change here cannot ripple into what an unrelated suite asserts.
/// </para>
/// <para>
/// There are <b>two</b> such callbacks on every builder, and the split is by target rather than by
/// convenience: <c>configure</c> (or the per-field <c>configureText</c>/<c>configureNumeric</c>/… on
/// <see cref="MultiFieldItemForm"/>) reaches a <i>field</i>, while <c>configureCollection</c> reaches
/// the <i>collection</i> — <c>AllowReorder</c>, <c>AllowAdd</c>, <c>WithMinItems</c> and the rest,
/// which no field callback can express. Until #300 only <see cref="MultiFieldItemForm"/> had the
/// latter, so a suite needing a collection-level setting on a single-field item form hand-rolled the
/// whole configuration; the parameter is now uniform across every builder here.
/// </para>
/// <para>
/// Both callbacks run <b>after</b> the builder has applied its own label and item form, so a caller
/// can override those. That ordering is the contract, and it is pinned by
/// <c>CollectionItemFixtureTests.Each_Item_Forms_Collection_Callback_Should_Run_After_The_Fixtures_Own_Configuration</c>
/// — a reorder-only test cannot catch a builder that invokes the callback first, because
/// <c>AllowReorder</c> is an independent setter that reads the same either way.
/// </para>
/// </summary>
internal static class CollectionItemFixture
Expand Down Expand Up @@ -121,70 +137,112 @@ internal static NamedOrderModel NewNamedOrder(string name = "", string itemName
/// <summary>
/// A collection whose item form holds one <c>string</c> field labelled "Product" — the text path.
/// </summary>
/// <param name="configure">Configures the item's field. Runs after its default label, so it can override it.</param>
/// <param name="configureCollection">
/// Configures the <i>collection</i> — <c>AllowReorder</c>, <c>AllowAdd</c>, <c>WithMinItems</c>
/// and the rest, none of which a field callback can reach. Runs after this builder has set the
/// label and the item form, so it can override those too (#300).
/// </param>
internal static IFormConfiguration<OrderModel> TextItemForm(
Action<FieldBuilder<OrderItem, string>>? configure = null) =>
Action<FieldBuilder<OrderItem, string>>? configure = null,
Action<CollectionFieldBuilder<OrderModel, OrderItem>>? configureCollection = null) =>
FormBuilder<OrderModel>
.Create()
.AddCollectionField(x => x.Items, collection => collection
.WithLabel("Items")
.WithItemForm(item => item
.AddField(x => x.ProductName, field =>
{
field.WithLabel("Product");
configure?.Invoke(field);
})))
.AddCollectionField(x => x.Items, collection =>
{
collection
.WithLabel("Items")
.WithItemForm(item => item
.AddField(x => x.ProductName, field =>
{
field.WithLabel("Product");
configure?.Invoke(field);
}));
configureCollection?.Invoke(collection);
})
.Build();

/// <summary>
/// A collection whose item form holds one <c>int</c> field labelled "Quantity" — the numeric path.
/// </summary>
/// <param name="configure">Configures the item's field. Runs after its default label, so it can override it.</param>
/// <param name="configureCollection">
/// Configures the <i>collection</i> rather than a field; runs last, after the label and item
/// form. See <see cref="TextItemForm"/> for the full contract (#300).
/// </param>
internal static IFormConfiguration<BasketModel> NumericItemForm(
Action<FieldBuilder<BasketLine, int>>? configure = null) =>
Action<FieldBuilder<BasketLine, int>>? configure = null,
Action<CollectionFieldBuilder<BasketModel, BasketLine>>? configureCollection = null) =>
FormBuilder<BasketModel>
.Create()
.AddCollectionField(x => x.Lines, collection => collection
.WithLabel("Lines")
.WithItemForm(item => item
.AddField(x => x.Quantity, field =>
{
field.WithLabel("Quantity");
configure?.Invoke(field);
})))
.AddCollectionField(x => x.Lines, collection =>
{
collection
.WithLabel("Lines")
.WithItemForm(item => item
.AddField(x => x.Quantity, field =>
{
field.WithLabel("Quantity");
configure?.Invoke(field);
}));
configureCollection?.Invoke(collection);
})
.Build();

/// <summary>
/// A collection whose item form holds one <c>DateTime</c> field labelled "When" — the date path.
/// </summary>
/// <param name="configure">Configures the item's field. Runs after its default label, so it can override it.</param>
/// <param name="configureCollection">
/// Configures the <i>collection</i> rather than a field; runs last, after the label and item
/// form. See <see cref="TextItemForm"/> for the full contract (#300).
/// </param>
internal static IFormConfiguration<AppointmentModel> DateItemForm(
Action<FieldBuilder<AppointmentSlot, DateTime>>? configure = null) =>
Action<FieldBuilder<AppointmentSlot, DateTime>>? configure = null,
Action<CollectionFieldBuilder<AppointmentModel, AppointmentSlot>>? configureCollection = null) =>
FormBuilder<AppointmentModel>
.Create()
.AddCollectionField(x => x.Slots, collection => collection
.WithLabel("Slots")
.WithItemForm(item => item
.AddField(x => x.When, field =>
{
field.WithLabel("When");
configure?.Invoke(field);
})))
.AddCollectionField(x => x.Slots, collection =>
{
collection
.WithLabel("Slots")
.WithItemForm(item => item
.AddField(x => x.When, field =>
{
field.WithLabel("When");
configure?.Invoke(field);
}));
configureCollection?.Invoke(collection);
})
.Build();

/// <summary>
/// A collection whose item form holds one <c>bool</c> field labelled "Gift" — the checkbox, the
/// one component that binds neither adornments nor <c>Required</c>.
/// </summary>
/// <param name="configure">Configures the item's field. Runs after its default label, so it can override it.</param>
/// <param name="configureCollection">
/// Configures the <i>collection</i> rather than a field; runs last, after the label and item
/// form. Distinct from <see cref="NumericItemForm"/>'s despite both configuring
/// <c>BasketModel.Lines</c> — separate builders wire separate callbacks (#300).
/// </param>
internal static IFormConfiguration<BasketModel> BooleanItemForm(
Action<FieldBuilder<BasketLine, bool>>? configure = null) =>
Action<FieldBuilder<BasketLine, bool>>? configure = null,
Action<CollectionFieldBuilder<BasketModel, BasketLine>>? configureCollection = null) =>
FormBuilder<BasketModel>
.Create()
.AddCollectionField(x => x.Lines, collection => collection
.WithLabel("Lines")
.WithItemForm(item => item
.AddField(x => x.IsGift, field =>
{
field.WithLabel("Gift");
configure?.Invoke(field);
})))
.AddCollectionField(x => x.Lines, collection =>
{
collection
.WithLabel("Lines")
.WithItemForm(item => item
.AddField(x => x.IsGift, field =>
{
field.WithLabel("Gift");
configure?.Invoke(field);
}));
configureCollection?.Invoke(collection);
})
.Build();

/// <summary>
Expand All @@ -193,18 +251,28 @@ internal static IFormConfiguration<BasketModel> BooleanItemForm(
/// <c>MudNumericField&lt;int&gt;</c>, so a suite that asserts on one has said nothing about the
/// other; culture-sensitive parsing in particular only shows up on the decimal one.
/// </summary>
/// <param name="configure">Configures the item's field. Runs after its default label, so it can override it.</param>
/// <param name="configureCollection">
/// Configures the <i>collection</i> rather than a field; runs last, after the label and item
/// form. See <see cref="TextItemForm"/> for the full contract (#300).
/// </param>
internal static IFormConfiguration<PricedBasketModel> DecimalItemForm(
Action<FieldBuilder<PricedLine, decimal>>? configure = null) =>
Action<FieldBuilder<PricedLine, decimal>>? configure = null,
Action<CollectionFieldBuilder<PricedBasketModel, PricedLine>>? configureCollection = null) =>
FormBuilder<PricedBasketModel>
.Create()
.AddCollectionField(x => x.Lines, collection => collection
.WithLabel("Lines")
.WithItemForm(item => item
.AddField(x => x.Price, field =>
{
field.WithLabel("Price");
configure?.Invoke(field);
})))
.AddCollectionField(x => x.Lines, collection =>
{
collection
.WithLabel("Lines")
.WithItemForm(item => item
.AddField(x => x.Price, field =>
{
field.WithLabel("Price");
configure?.Invoke(field);
}));
configureCollection?.Invoke(collection);
})
.Build();

/// <summary>
Expand Down Expand Up @@ -260,11 +328,12 @@ internal static MixedItemModel NewMixedItems(params MixedItem[] rows)
/// those two; the others still render, which is what makes the row mixed.
/// </para>
/// <para>
/// <paramref name="configureCollection"/> is the one callback here that reaches the
/// <i>collection</i> rather than a field. The reorder test needs <c>.AllowReorder()</c>, which is
/// a property of the collection, and without it that suite would have to hand-roll the whole
/// configuration — and would keep its own model copy along with it, which is the duplication
/// this member exists to remove.
/// <paramref name="configureCollection"/> is the callback that reaches the <i>collection</i>
/// rather than a field: the reorder test needs <c>.AllowReorder()</c>, a property of the
/// collection, and without it that suite would have to hand-roll the whole configuration — and
/// would keep its own model copy along with it, the duplication this member exists to remove.
/// This member had it first (#282); #300 gave every other builder here the same parameter, so it
/// is no longer special — see the class summary for the ordering contract it shares with them.
/// </para>
/// </remarks>
internal static IFormConfiguration<MixedItemModel> MultiFieldItemForm(
Expand Down Expand Up @@ -391,24 +460,36 @@ internal static IFormConfiguration<TwoCollectionModel> TwoCollectionItemForm(
/// labels would buy nothing and would leave a caller unable to tell the root field from the item
/// field in a rendered form.
/// </remarks>
/// <param name="configureRoot">Configures the top-level field. Runs after its default label.</param>
/// <param name="configureItem">Configures the item's field. Runs after its default label.</param>
/// <param name="configureCollection">
/// Configures the <i>collection</i> rather than either field; appended last so every existing
/// call site, positional or named, still compiles. See <see cref="TextItemForm"/> for the full
/// contract (#300).
/// </param>
internal static IFormConfiguration<NamedOrderModel> RootFieldAndItemForm(
Action<FieldBuilder<NamedOrderModel, string>>? configureRoot = null,
Action<FieldBuilder<NamedOrderItem, string>>? configureItem = null) =>
Action<FieldBuilder<NamedOrderItem, string>>? configureItem = null,
Action<CollectionFieldBuilder<NamedOrderModel, NamedOrderItem>>? configureCollection = null) =>
FormBuilder<NamedOrderModel>
.Create()
.AddField(x => x.Name, field =>
{
field.WithLabel("Name");
configureRoot?.Invoke(field);
})
.AddCollectionField(x => x.Items, collection => collection
.WithLabel("Items")
.WithItemForm(item => item
.AddField(x => x.Name, field =>
{
field.WithLabel("Item name");
configureItem?.Invoke(field);
})))
.AddCollectionField(x => x.Items, collection =>
{
collection
.WithLabel("Items")
.WithItemForm(item => item
.AddField(x => x.Name, field =>
{
field.WithLabel("Item name");
configureItem?.Invoke(field);
}));
configureCollection?.Invoke(collection);
})
.Build();
}

Expand Down
Loading
Loading