Add EF Core MoneyConvention for auto-mapping Money types by xavierjohn · Pull Request #314 · xavierjohn/Trellis

xavierjohn · 2026-03-02T16:12:58Z

Introduces MoneyConvention to Trellis.EntityFrameworkCore, enabling automatic mapping of Money properties as owned types with standardized column naming (e.g., Price, PriceCurrency) and correct precision. Updates ApplyTrellisConventions to register this convention. Modifies Money value object for EF Core compatibility. Adds documentation and a comprehensive test suite to verify convention behavior and override support. This eliminates the need for manual configuration of Money properties in EF Core entities.

github-actions · 2026-03-02T16:15:32Z

Test Results

3 222 tests +9 3 222 ✅ +9 2m 6s ⏱️ -54s
14 suites ±0 0 💤 ±0
14 files ±0 0 ❌ ±0

Results for commit 9a320d8. ± Comparison against base commit bdad68e.

♻️ This comment has been updated with latest results.

Copilot

Pull request overview

Adds first-class EF Core convention support for Money so consumers can persist Money properties without manual OwnsOne configuration, while updating documentation and tests to describe and validate the behavior.

Changes:

Introduces MoneyConvention and registers it via ApplyTrellisConventions to auto-map Money as an owned type with standardized column naming.
Updates Money to support EF Core materialization (private parameterless ctor + private setters).
Adds a new MoneyConventionTests suite and updates docs/README/changelog/API reference to document the convention and override behavior.

Reviewed changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated 8 comments.

Show a summary per file

File	Description
`Trellis.EntityFrameworkCore/src/MoneyConvention.cs`	New EF Core convention to register `Money` as owned and configure column naming/precision/length.
`Trellis.EntityFrameworkCore/src/ModelConfigurationBuilderExtensions.cs`	Registers the new `MoneyConvention` inside `ApplyTrellisConventions`.
`Trellis.Primitives/src/Primitives/Money.cs`	Enables EF Core materialization via private setters + private parameterless constructor.
`Trellis.EntityFrameworkCore/tests/MoneyConventionTests.cs`	Adds tests validating column naming, precision/length, round-trips, and explicit override precedence.
`docs/docfx_project/articles/integration-ef.md`	Adds a “Money Property Convention” section to the EF Core integration guide.
`Trellis.EntityFrameworkCore/README.md`	Documents the Money convention in the package README.
`Trellis.EntityFrameworkCore/NUGET_README.md`	Documents the Money convention for NuGet package description.
`trellis-api-reference.md`	Updates API reference to mention Money auto-mapping via conventions.
`CHANGELOG.md`	Notes the addition of the Money convention and Money EF materialization support.
`.github/copilot-instructions.md`	Adds internal guidance documenting Money EF Core behavior.

Copilot · 2026-03-02T16:20:46Z

.github/copilot-instructions.md

+| `Price` | `Price` | `PriceCurrency` |
+| `ShippingCost` | `ShippingCost` | `ShippingCostCurrency` |
+
+Amount columns: `decimal(18,2)`. Currency columns: `nvarchar(3)` (ISO 4217).


This line states amount columns are decimal(18,2), but Money supports some 3-decimal currencies. Update this guidance to match the convention’s final precision/scale decision, or document the rounding/truncation limitation.

Suggested change

Amount columns: `decimal(18,2)`. Currency columns: `nvarchar(3)` (ISO 4217).

By default, amount columns are mapped as `decimal(18,2)`. This works for most currencies but will round or truncate 3-decimal currencies to 2 decimal places; configure `HasPrecision` (for example, `HasPrecision(18,3)` or higher) on the amount property if you need full 3-decimal support. Currency columns: `nvarchar(3)` (ISO 4217).

Copilot · 2026-03-02T16:20:47Z

Trellis.EntityFrameworkCore/src/MoneyConvention.cs

+                amount.Builder.HasAnnotation("Relational:ColumnName", navigationName);
+                amount.Builder.HasPrecision(18);
+                amount.Builder.HasScale(2);
+            }


The convention forces Money.Amount to scale 2, but Money supports currencies with 3 decimal places (e.g., BHD/KWD/OMR/TND). On providers that enforce scale, this will round/truncate persisted values and break round-trips. Consider using a scale that can represent the maximum supported decimals (e.g., 3) or persisting minor units instead.

Copilot · 2026-03-02T16:20:47Z

Trellis.EntityFrameworkCore/src/MoneyConvention.cs

+                amount.Builder.HasAnnotation("Relational:ColumnName", navigationName);
+                amount.Builder.HasPrecision(18);


"Relational:ColumnName" is used as a magic-string annotation key (twice in this method). Prefer EF Core’s relational constants/APIs (e.g., RelationalAnnotationNames.ColumnName / relational HasColumnName) so this doesn’t depend on an internal string key.

Copilot · 2026-03-02T16:20:48Z

trellis-api-reference.md

+| `Price` | `Price` | `PriceCurrency` | `decimal(18,2)` | `nvarchar(3)` |
+| `ShippingCost` | `ShippingCost` | `ShippingCostCurrency` | `decimal(18,2)` | `nvarchar(3)` |


Copilot · 2026-03-02T16:20:48Z

docs/docfx_project/articles/integration-ef.md

+| `Price` | `Price` | `PriceCurrency` |
+| `ShippingCost` | `ShippingCost` | `ShippingCostCurrency` |
+
+Amount columns use `decimal(18,2)` precision. Currency columns use `nvarchar(3)` (ISO 4217).


Docs state amount columns use decimal(18,2), but Money supports some 3-decimal currencies. Consider updating the convention/docs to a scale that can represent the max supported decimals, or call out the rounding/truncation limitation explicitly.

Suggested change

Amount columns use `decimal(18,2)` precision. Currency columns use `nvarchar(3)` (ISO 4217).

By default, amount columns are configured as `decimal(18,2)`, which is sufficient for currencies with 2 decimal places but will round or truncate 3-decimal currencies. Use a higher scale (for example, `decimal(18,3)` or `HasPrecision(19, 4)` as shown below) if you need to store 3-decimal currencies without loss. Currency columns use `nvarchar(3)` (ISO 4217).

Copilot · 2026-03-02T16:20:48Z

Trellis.EntityFrameworkCore/README.md

+| `Price` | `Price` | `PriceCurrency` |
+| `ShippingCost` | `ShippingCost` | `ShippingCostCurrency` |
+
+Amount columns use `decimal(18,2)` precision. Currency columns use `nvarchar(3)` (ISO 4217).


This section says amount columns use decimal(18,2), but Money supports some 3-decimal currencies. Consider updating the convention/docs to support the max scale (or document the rounding/truncation limitation).

Suggested change

Amount columns use `decimal(18,2)` precision. Currency columns use `nvarchar(3)` (ISO 4217).

By default, amount columns use `decimal(18,2)` precision. This supports most currencies, but three-decimal currencies (for example, JOD, KWD, BHD) will be rounded or truncated to two decimal places unless you override the precision via `OwnsOne` (see below). Currency columns use `nvarchar(3)` (ISO 4217).

Copilot · 2026-03-02T16:20:49Z

Trellis.EntityFrameworkCore/NUGET_README.md

+| `Price` | `Price` | `PriceCurrency` | `decimal(18,2)` | `nvarchar(3)` |
+| `ShippingCost` | `ShippingCost` | `ShippingCostCurrency` | `decimal(18,2)` | `nvarchar(3)` |


Copilot · 2026-03-02T16:20:49Z

CHANGELOG.md


+#### Trellis.EntityFrameworkCore — Money Convention
+
+- **`MoneyConvention`** — `ApplyTrellisConventions` now automatically maps `Money` properties as owned types with `{PropertyName}` (decimal 18,2) + `{PropertyName}Currency` (nvarchar 3) columns. No `OwnsOne` configuration needed. Explicit `OwnsOne` takes precedence.


Changelog claims {PropertyName} is stored as decimal 18,2, but Money supports some 3-decimal currencies. If you change the convention to a higher scale to avoid truncation, update this entry; otherwise consider noting the limitation/rounding behavior.

Suggested change

- **`MoneyConvention`** — `ApplyTrellisConventions` now automatically maps `Money` properties as owned types with `{PropertyName}` (decimal 18,2) + `{PropertyName}Currency` (nvarchar 3) columns. No `OwnsOne` configuration needed. Explicit `OwnsOne` takes precedence.

- **`MoneyConvention`** — `ApplyTrellisConventions` now automatically maps `Money` properties as owned types with `{PropertyName}` (decimal 18,2) + `{PropertyName}Currency` (nvarchar 3) columns. Note: this default mapping uses two decimal places; currencies requiring three decimal places will be rounded by the database provider to two decimal places. No `OwnsOne` configuration needed. Explicit `OwnsOne` takes precedence.

codecov · 2026-03-02T16:30:27Z

Codecov Report

❌ Patch coverage is 95.23810% with 1 line in your changes missing coverage. Please review.
✅ Project coverage is 85.57%. Comparing base (bdad68e) to head (9a320d8).
⚠️ Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
Trellis.EntityFrameworkCore/src/MoneyConvention.cs	94.11%	0 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #314      +/-   ##
==========================================
+ Coverage   85.51%   85.57%   +0.05%     
==========================================
  Files         158      159       +1     
  Lines        4930     4949      +19     
  Branches     1012     1019       +7     
==========================================
+ Hits         4216     4235      +19     
+ Misses        419      418       -1     
- Partials      295      296       +1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

MoneyConvention now maps Money.Amount columns as decimal(18,3) (instead of decimal(18,2)) to support all ISO 4217 minor units, including currencies with three decimal places (e.g., KWD, BHD). Docs and tests updated to reflect this change. Implementation now uses RelationalAnnotationNames.ColumnName and sets scale to 3. Added test for three-decimal currency round-trip. Switched package references to Microsoft.EntityFrameworkCore.Relational.

Copilot

Pull request overview

Copilot reviewed 12 out of 12 changed files in this pull request and generated 1 comment.

Copilot · 2026-03-02T16:52:01Z

trellis-api-reference.md

 // In OnModelCreating or ConfigureConventions
 configurationBuilder.ApplyTrellisConventions(typeof(Order).Assembly);
 // Auto-registers converters for all IScalarValue and RequiredEnum types
+// Auto-maps Money properties as owned types (Amount + Currency columns)


The comment says ApplyTrellisConventions can be used in OnModelCreating, but the API is an extension on ModelConfigurationBuilder and is only callable from ConfigureConventions. Update this snippet/comment to avoid misleading usage.

Suggested change

// In OnModelCreating or ConfigureConventions

configurationBuilder.ApplyTrellisConventions(typeof(Order).Assembly);

// Auto-registers converters for all IScalarValue and RequiredEnum types

// Auto-maps Money properties as owned types (Amount + Currency columns)

// In your DbContext.ConfigureConventions override

protected override void ConfigureConventions(ModelConfigurationBuilder configurationBuilder)

{

configurationBuilder.ApplyTrellisConventions(typeof(Order).Assembly);

// Auto-registers converters for all IScalarValue and RequiredEnum types

// Auto-maps Money properties as owned types (Amount + Currency columns)

}

xavierjohn requested a review from Copilot March 2, 2026 16:13

Copilot started reviewing on behalf of xavierjohn March 2, 2026 16:13 View session

Copilot AI reviewed Mar 2, 2026

View reviewed changes

xavierjohn requested a review from Copilot March 2, 2026 16:45

Copilot started reviewing on behalf of xavierjohn March 2, 2026 16:46 View session

Copilot AI reviewed Mar 2, 2026

View reviewed changes

xavierjohn merged commit 7f1fda4 into main Mar 2, 2026
10 checks passed

	Amount columns: `decimal(18,2)`. Currency columns: `nvarchar(3)` (ISO 4217).
	By default, amount columns are mapped as `decimal(18,2)`. This works for most currencies but will round or truncate 3-decimal currencies to 2 decimal places; configure `HasPrecision` (for example, `HasPrecision(18,3)` or higher) on the amount property if you need full 3-decimal support. Currency columns: `nvarchar(3)` (ISO 4217).

		amount.Builder.HasAnnotation("Relational:ColumnName", navigationName);
		amount.Builder.HasPrecision(18);

		\| `Price` \| `Price` \| `PriceCurrency` \| `decimal(18,2)` \| `nvarchar(3)` \|
		\| `ShippingCost` \| `ShippingCost` \| `ShippingCostCurrency` \| `decimal(18,2)` \| `nvarchar(3)` \|

	Amount columns use `decimal(18,2)` precision. Currency columns use `nvarchar(3)` (ISO 4217).
	By default, amount columns are configured as `decimal(18,2)`, which is sufficient for currencies with 2 decimal places but will round or truncate 3-decimal currencies. Use a higher scale (for example, `decimal(18,3)` or `HasPrecision(19, 4)` as shown below) if you need to store 3-decimal currencies without loss. Currency columns use `nvarchar(3)` (ISO 4217).

	Amount columns use `decimal(18,2)` precision. Currency columns use `nvarchar(3)` (ISO 4217).
	By default, amount columns use `decimal(18,2)` precision. This supports most currencies, but three-decimal currencies (for example, JOD, KWD, BHD) will be rounded or truncated to two decimal places unless you override the precision via `OwnsOne` (see below). Currency columns use `nvarchar(3)` (ISO 4217).


		#### Trellis.EntityFrameworkCore — Money Convention

		- `MoneyConvention` — `ApplyTrellisConventions` now automatically maps `Money` properties as owned types with `{PropertyName}` (decimal 18,2) + `{PropertyName}Currency` (nvarchar 3) columns. No `OwnsOne` configuration needed. Explicit `OwnsOne` takes precedence.

Conversation

xavierjohn commented Mar 2, 2026

Uh oh!

github-actions bot commented Mar 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Test Results

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Mar 2, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 2, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 2, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 2, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 2, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 2, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 2, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 2, 2026

Choose a reason for hiding this comment

Uh oh!

codecov bot commented Mar 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Mar 2, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

github-actions bot commented Mar 2, 2026 •

edited

Loading

codecov bot commented Mar 2, 2026 •

edited

Loading