Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stijnmoreels/fprimitive
.NET project to help developers to build a correct and more safe domain model
https://github.com/stijnmoreels/fprimitive
boundaries ddd domain fsharp immutable model primitive secure trust types untrusted
Last synced: 11 days ago
JSON representation
.NET project to help developers to build a correct and more safe domain model
- Host: GitHub
- URL: https://github.com/stijnmoreels/fprimitive
- Owner: stijnmoreels
- License: unlicense
- Created: 2019-04-27T08:13:51.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-03-20T05:52:49.000Z (8 months ago)
- Last Synced: 2024-10-13T21:09:34.822Z (25 days ago)
- Topics: boundaries, ddd, domain, fsharp, immutable, model, primitive, secure, trust, types, untrusted
- Language: F#
- Homepage: https://stijnmoreels.github.io/FPrimitive/
- Size: 14 MB
- Stars: 30
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
[](https://www.nuget.org/packages/fprimitive)
[](https://codecov.io/gh/stijnmoreels/FPrimitive)
# FPrimitive
FPrimitive is a .NET project to help developers build a correct and more secure domain model by providing building blocks, standard types and trust boundaries.
## Build Status
| Mono | .NET |
| --------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| [](https://travis-ci.org/stijnmoreels/FPrimitive) | [](https://ci.appveyor.com/project/stijnmoreels/fprimitive) |
## Documentation
The project has a wiki page with further information and some additional resources are also listed here:
* [Library Documentation Page](https://stijnmoreels.github.io/FPrimitive)
* [Domain-Driven Security w/ F# FPrimitive & C# Interop](https://www.codit.eu/blog/domain-driven-security-with-f-fprimitive-and-c-interop/)
* [From Untrusted Input to Strict Model w/ Layered JSON Parsing in F# FPrimitive](https://www.codit.eu/blog/from-untrusted-input-to-strict-model-with-layered-json-parsing-in-f-fprimitive-c/)
## Examples
The project contains several reusable building blocks to make your domain model more correct and therefore more secure.
```fsharp
open FPrimitive
/// Composible specifications for your domain types:
type NonEmptyString =
private NonEmptyString of string with
static member create x : Result> =
Spec.def
|> Spec.notNull "should not be null"
|> Spec.notEmpty "should not be empty"
|> Spec.createModel NonEmptyString x
/// ...also available as computation expression.
type NonEmptyList<'a> =
private NonEmptyList of 'a list with
static member create xs : Result, Map> =
specModel NonEmptyList xs {
nonEmpty "list should not be empty"
lengthBetween 1 10 "list length should be between 1-10" }
/// Access controllers for your critical application resources:
let uncontrolled_critical = ignore
let critical =
Access.func uncontrolled_critical
|> Access.once
|> Access.duringHours 9 17
|> Access.revokable
/// Try to evaluate
Access.eval () critical
/// Revoke when neccessary
Access.revoke critical
```
With full C# support!
```csharp
using FPrimitive;
public class PositiveInt
{
private PrositiveInt(int value) { Value = int; }
public int value { get; }
public static ValidationResult Create(int value)
{
return Spec.Of()
.GreaterThan(0, "Positive integer should be greater than zero")
.CreateModel(value, validated => new PositiveInt(validated));
}
}
```