Motiv 7.1.0

Motiv

Know Why, not just What

Motiv is a developer-first .NET library that transforms the way you work with boolean logic. It lets you form expressions from discrete propositions so that you can explain why decisions were made.

First create atomic propositions:

// Define propositions
var isValid = Spec.Build((int n) => n is >= 0 and <= 11).Create("valid");
var isEmpty = Spec.Build((int n) => n == 0).Create("empty");
var isFull  = Spec.Build((int n) => n == 11).Create("full");

Then compose using operators (e.g., !, &, |, ^):

// Compose a new proposition
var expression = isValid & !(isEmpty | isFull);

To get detailed feedback:

var isPartiallyFull =  Spec.Build(expression).Create("partial");

var result = isPartiallyFull.IsSatisfiedBy(5);

result.Satisfied;     // true
result.Assertions;    // ["partial"]
result.Justifications // partial
                      //     AND
                      //         valid
                      //         NOR
                      //             !empty
                      //             !full

Why Use Motiv?

Motiv primarily gives you visibility into your application's decision-making process. By decomposing expressions into propositions, it addresses important architectural concerns and enables more advanced use cases, such as implementing rules engines.

Consider using Motiv if your project requires two or more of the following:

1. Visibility: Provide detailed, real-time feedback about decisions made.
2. Decomposition: Break down complex logic into meaningful subclauses for improved readability.
3. Reusability: Reuse logic across multiple locations to reduce duplication.
4. Modeling: Explicitly model your domain logic.
5. Testing: Easily test your logic without mocking or stubbing dependencies.

Use Cases

Motiv can be applied in various scenarios, including:

• User Feedback: Provide detailed explanations about decision outcomes.
• Debugging: Quickly find out the causes from complex logic.
• Multilingual Support: Offer explanations in different languages.
• Validation: Ensure user input meets specific criteria and provide detailed feedback.
• Auditing: Log why something happened, and not just what.

Installation

Install Motiv via NuGet Package Manager Console:

Install-Package Motiv

Or using the .NET CLI:

dotnet add package Motiv

Usage

Basic Proposition

Create and evaluate a basic proposition:

var isEligibleForLoan =
    Spec.Build((Customer customer) =>
            customer is
            {
                CreditScore: > 600,
                Income: > 100000
            })
        .Create("eligible for loan");

var result = isEligibleForLoan.IsSatisfiedBy(eligibleCustomer);

result.Satisfied;  // true
result.Reason;     // "eligible for loan"
result.Assertions; // ["eligible for loan"]

Propositions with Custom Assertions

Use WhenTrue() and WhenFalse() for user-friendly explanations:

var isEligibleForLoan =
    Spec.Build((Customer customer) =>
            customer is
            {
                CreditScore: > 600,
                Income: > 100000
            })
        .WhenTrue("eligible for a loan")
        .WhenFalse("not eligible for a loan")
        .Create();

Composing Propositions

Combine propositions using boolean operators:

var hasGoodCreditScore =
    Spec.Build((Customer customer) => customer.CreditScore > 600)
        .WhenTrue("good credit score")
        .WhenFalse("inadequate credit score")
        .Create();

var hasSufficientIncome =
    Spec.Build((Customer customer) => customer.Income > 100000)
        .WhenTrue("sufficient income")
        .WhenFalse("insufficient income")
        .Create();

var isEligibleForLoan = hasGoodCreditScore & hasSufficientIncome;

var result = isEligibleForLoan.IsSatisfiedBy(eligibleCustomer);

result.Satisfied;  // true
result.Reason;     // "good credit score & sufficient income"
result.Assertions; // ["good credit score", "sufficient income"]

Higher Order Logic

Provide facts about collections:

var allNegative =
    Spec.Build((int n) => n < 0)
        .AsAllSatisfied()
        .WhenTrue("all are negative")
        .WhenFalseYield(eval => eval.FalseModels.Select(n => $"{n} is not negative"))
        .Create();

var result = allNegative.IsSatisfiedBy([-1, 2, 3]);

result.Satisfied;  // false
result.Assertions; // ["2 is not negative", "3 is not negative"]

Tradeoffs

Consider these potential tradeoffs when using Motiv:

1. Performance: Motiv isn't optimized for high-performance scenarios where nanoseconds matter.
2. Dependency: Once integrated, Motiv becomes a core dependency in your codebase.
3. Learning Curve: While Motiv introduces a new approach, it's designed to be intuitive and easy to use.

License

Motiv is released under the MIT License. See the LICENSE file for details.

Resources

• Documentation
• NuGet Package
• Official GitHub Repository