mon-entreprise/source/engine/mecanisms.js

874 lines
24 KiB
JavaScript

import { desugarScale } from 'Engine/mecanisms/barème';
import { decompose, devariateExplanation } from 'Engine/mecanisms/utils';
import { add, any, aperture, curry, equals, evolve, filter, find, head, is, isEmpty, isNil, keys, last, map, max, mergeWith, min, path, pipe, pluck, prop, propEq, reduce, reduced, reject, sort, subtract, toPairs } from 'ramda';
import React from 'react';
import { Trans } from 'react-i18next';
import 'react-virtualized/styles.css';
import { bonus, collectNodeMissing, defaultNode, evaluateArray, evaluateNode, evaluateObject, makeJsx, mergeAllMissing, mergeMissing, parseObject, rewriteNode } from './evaluation';
import Allègement from './mecanismViews/Allègement';
import Barème from './mecanismViews/Barème';
import BarèmeContinu from './mecanismViews/BarèmeContinu';
import { Node, SimpleRuleLink } from './mecanismViews/common';
import InversionNumérique from './mecanismViews/InversionNumérique';
import Product from './mecanismViews/Product';
import Somme from './mecanismViews/Somme';
import Variations from './mecanismViews/Variations';
import { disambiguateRuleReference, findRuleByDottedName } from './rules';
import { anyNull, val } from './traverse-common-functions';
import uniroot from './uniroot';
/* @devariate = true => This function will produce variations of a same mecanism (e.g. product) that share some common properties */
export let mecanismVariations = (recurse, k, v, devariate) => {
let explanation = devariate
? devariateExplanation(recurse, k, v)
: v.map(({ si, alors, sinon }) =>
sinon !== undefined
? { consequence: recurse(sinon), condition: undefined }
: { consequence: recurse(alors), condition: recurse(si) }
)
let evaluate = (cache, situationGate, parsedRules, node) => {
let evaluateVariationProp = prop =>
prop === undefined
? undefined
: evaluateNode(cache, situationGate, parsedRules, prop),
// mark the satisfied variation if any in the explanation
[, resolvedExplanation] = reduce(
([resolved, result], variation) => {
if (resolved) return [true, [...result, variation]]
// evaluate the condition
let evaluatedCondition = evaluateVariationProp(variation.condition)
if (evaluatedCondition == undefined) {
// We've reached the eventual defaut case
let evaluatedVariation = {
consequence: evaluateVariationProp(variation.consequence),
satisfied: true
}
return [true, [...result, evaluatedVariation]]
}
if (evaluatedCondition.nodeValue === null)
// one case has missing variables => we can't go further
return [true, [...result, { condition: evaluatedCondition }]]
if (evaluatedCondition.nodeValue === true) {
let evaluatedVariation = {
condition: evaluatedCondition,
consequence: evaluateVariationProp(variation.consequence),
satisfied: true
}
return [true, [...result, evaluatedVariation]]
}
return [false, [...result, variation]]
},
[false, []]
)(node.explanation),
satisfiedVariation = resolvedExplanation.find(v => v.satisfied),
nodeValue = satisfiedVariation
? satisfiedVariation.consequence.nodeValue
: null
let leftMissing = mergeAllMissing(
reject(isNil, pluck('condition', resolvedExplanation))
),
candidateVariations = filter(
node => !node.condition || node.condition.nodeValue !== false,
resolvedExplanation
),
rightMissing = mergeAllMissing(
reject(isNil, pluck('consequence', candidateVariations))
),
missingVariables = satisfiedVariation
? collectNodeMissing(satisfiedVariation.consequence)
: mergeMissing(bonus(leftMissing), rightMissing)
return rewriteNode(node, nodeValue, resolvedExplanation, missingVariables)
}
// TODO - find an appropriate representation
return {
explanation,
evaluate,
jsx: Variations,
category: 'mecanism',
name: 'variations',
type: 'numeric'
}
}
export let mecanismOneOf = (recurse, k, v) => {
if (!is(Array, v)) throw new Error('should be array')
let explanation = map(recurse, v)
let jsx = (nodeValue, explanation) => (
<Node
classes="mecanism conditions list"
name="une de ces conditions"
value={nodeValue}
child={
<ul>
{explanation.map(item => (
<li key={item.name || item.text}>{makeJsx(item)}</li>
))}
</ul>
}
/>
)
let evaluate = (cache, situationGate, parsedRules, node) => {
let evaluateOne = child =>
evaluateNode(cache, situationGate, parsedRules, child),
explanation = map(evaluateOne, node.explanation),
values = pluck('nodeValue', explanation),
nodeValue = any(equals(true), values)
? true
: any(equals(null), values)
? null
: false,
// Unlike most other array merges of missing variables this is a "flat" merge
// because "one of these conditions" tend to be several tests of the same variable
// (e.g. contract type is one of x, y, z)
missingVariables =
nodeValue == null
? reduce(mergeWith(max), {}, map(collectNodeMissing, explanation))
: {}
return rewriteNode(node, nodeValue, explanation, missingVariables)
}
return {
evaluate,
jsx,
explanation,
category: 'mecanism',
name: 'une de ces conditions',
type: 'boolean'
}
}
export let mecanismAllOf = (recurse, k, v) => {
if (!is(Array, v)) throw new Error('should be array')
let explanation = map(recurse, v)
let jsx = (nodeValue, explanation) => (
<Node
classes="mecanism conditions list"
name="toutes ces conditions"
value={nodeValue}
child={
<ul>
{explanation.map(item => (
<li key={item.name || item.text}>{makeJsx(item)}</li>
))}
</ul>
}
/>
)
let evaluate = (cache, situationGate, parsedRules, node) => {
let evaluateOne = child =>
evaluateNode(cache, situationGate, parsedRules, child),
explanation = map(evaluateOne, node.explanation),
values = pluck('nodeValue', explanation),
nodeValue = any(equals(false), values)
? false // court-circuit
: any(equals(null), values)
? null
: true,
missingVariables = nodeValue == null ? mergeAllMissing(explanation) : {}
return rewriteNode(node, nodeValue, explanation, missingVariables)
}
return {
evaluate: evaluate,
jsx,
explanation,
category: 'mecanism',
name: 'toutes ces conditions',
type: 'boolean'
}
}
export let mecanismNumericalSwitch = (recurse, k, v) => {
// Si "l'aiguillage" est une constante ou une référence directe à une variable;
// l'utilité de ce cas correspond à un appel récursif au mécanisme
if (is(String, v)) return recurse(v)
if (!is(Object, v) || keys(v).length == 0) {
throw new Error(
'Le mécanisme "aiguillage numérique" et ses sous-logiques doivent contenir au moins une proposition'
)
}
// les termes sont les couples (condition, conséquence) de l'aiguillage numérique
let terms = toPairs(v)
// la conséquence peut être un 'string' ou un autre aiguillage numérique
let parseCondition = ([condition, consequence]) => {
let conditionNode = recurse(condition), // can be a 'comparison', a 'variable', TODO a 'negation'
consequenceNode = mecanismNumericalSwitch(recurse, condition, consequence)
let evaluate = (cache, situationGate, parsedRules, node) => {
let explanation = evolve(
{
condition: curry(evaluateNode)(cache, situationGate, parsedRules),
consequence: curry(evaluateNode)(cache, situationGate, parsedRules)
},
node.explanation
),
leftMissing = explanation.condition.missingVariables,
investigate = explanation.condition.nodeValue !== false,
rightMissing = investigate
? explanation.consequence.missingVariables
: {},
missingVariables = mergeMissing(bonus(leftMissing), rightMissing)
return {
...node,
explanation,
missingVariables,
nodeValue: explanation.consequence.nodeValue,
condValue: explanation.condition.nodeValue
}
}
let jsx = (nodeValue, { condition, consequence }) => (
<div className="condition">
{makeJsx(condition)}
<div>{makeJsx(consequence)}</div>
</div>
)
return {
evaluate,
jsx,
explanation: { condition: conditionNode, consequence: consequenceNode },
category: 'condition',
text: condition,
condition: conditionNode,
type: 'boolean'
}
}
let evaluateTerms = (cache, situationGate, parsedRules, node) => {
let evaluateOne = child =>
evaluateNode(cache, situationGate, parsedRules, child),
explanation = map(evaluateOne, node.explanation),
nonFalsyTerms = filter(node => node.condValue !== false, explanation),
getFirst = o =>
pipe(
head,
prop(o)
)(nonFalsyTerms),
nodeValue =
// voilà le "numérique" dans le nom de ce mécanisme : il renvoie zéro si aucune condition n'est vérifiée
isEmpty(nonFalsyTerms)
? 0
: // c'est un 'null', on renvoie null car des variables sont manquantes
getFirst('condValue') == null
? null
: // c'est un true, on renvoie la valeur de la conséquence
getFirst('nodeValue'),
choice = find(node => node.condValue, explanation),
missingVariables = choice
? choice.missingVariables
: mergeAllMissing(explanation)
return rewriteNode(node, nodeValue, explanation, missingVariables)
}
let explanation = map(parseCondition, terms)
let jsx = (nodeValue, explanation) => (
<Node
classes="mecanism numericalSwitch list"
name="aiguillage numérique"
value={nodeValue}
child={
<ul>
{explanation.map(item => (
<li key={item.name || item.text}>{makeJsx(item)}</li>
))}
</ul>
}
/>
)
return {
evaluate: evaluateTerms,
jsx,
explanation,
category: 'mecanism',
name: 'aiguillage numérique',
type: 'boolean || numeric' // lol !
}
}
export let findInversion = (situationGate, parsedRules, v, dottedName) => {
let inversions = v.avec
if (!inversions)
throw new Error(
"Une formule d'inversion doit préciser _avec_ quoi on peut inverser la variable"
)
/*
Quelle variable d'inversion possible a sa valeur renseignée dans la situation courante ?
Ex. s'il nous est demandé de calculer le salaire de base, est-ce qu'un candidat à l'inversion, comme
le salaire net, a été renseigné ?
*/
let candidates = inversions
.map(i =>
disambiguateRuleReference(
parsedRules,
parsedRules.find(propEq('dottedName', dottedName)),
i
)
)
.map(name => {
let userInput = situationGate(name) != undefined
let rule = findRuleByDottedName(parsedRules, name)
/* When the fixedObjectiveValue is null, the inversion can't be done : the user needs to set the target's value
* But the objectiveRule can also have an 'alternative' property,
* which must point to a rule whose value either is set by the user,
* or is calculated according to a formula that does not depend on the rule being inversed.
* This alternative's value will be used as a target.
* */
let alternativeRule =
!userInput &&
rule.alternative &&
findRuleByDottedName(parsedRules, rule.alternative)
if (!userInput && !alternativeRule) return null
return {
fixedObjectiveRule: rule,
userInput,
fixedObjectiveValue: situationGate(name),
alternativeRule
}
}),
candidateWithUserInput = candidates.find(c => c && c.userInput)
return (
candidateWithUserInput || candidates.find(candidate => candidate != null)
)
}
let doInversion = (oldCache, situationGate, parsedRules, v, dottedName) => {
let inversion = findInversion(situationGate, parsedRules, v, dottedName)
if (!inversion)
return {
missingVariables: { [dottedName]: 1 },
nodeValue: null
}
let { fixedObjectiveValue, fixedObjectiveRule, alternativeRule } = inversion
let evaluatedAlternative =
alternativeRule &&
evaluateNode(oldCache, situationGate, parsedRules, alternativeRule)
if (evaluatedAlternative && evaluatedAlternative.nodeValue == null)
return {
missingVariables: evaluatedAlternative.missingVariables,
nodeValue: null
}
let objectiveValue = evaluatedAlternative
? evaluatedAlternative.nodeValue
: fixedObjectiveValue
let inversionCache = {}
let fx = x => {
inversionCache = { parseLevel: oldCache.parseLevel + 1, op: '<' }
let v = evaluateNode(
inversionCache, // with an empty cache
n =>
dottedName === n
? x
: n === 'sys.filter'
? undefined
: situationGate(n),
parsedRules,
fixedObjectiveRule
)
return v
}
// si fx renvoie null pour une valeur numérique standard, disons 1000, on peut
// considérer que l'inversion est impossible du fait de variables manquantes
// TODO fx peut être null pour certains x, et valide pour d'autres : on peut implémenter ici le court-circuit
let attempt = fx(1000)
if (attempt.nodeValue == null) {
return attempt
}
let tolerance = 0.1,
// cette fonction détermine la racine d'une fonction sans faire trop d'itérations
nodeValue = uniroot(
x => {
let y = fx(x)
return y.nodeValue - objectiveValue
},
0.1,
1000000000,
tolerance,
10
)
return {
nodeValue,
missingVariables: {},
inversionCache,
inversedWith: {
rule: fixedObjectiveRule,
value: fixedObjectiveValue
}
}
}
export let mecanismInversion = dottedName => (recurse, k, v) => {
let evaluate = (cache, situationGate, parsedRules, node) => {
let inversion =
// avoid the inversion loop !
situationGate(dottedName) == undefined &&
doInversion(cache, situationGate, parsedRules, v, dottedName),
// TODO - ceci n'est pas vraiment satisfaisant
nodeValue = situationGate(dottedName)
? Number.parseFloat(situationGate(dottedName))
: inversion.nodeValue,
missingVariables = inversion.missingVariables
if (nodeValue === undefined)
cache.inversionFail = {
given: inversion.inversedWith.rule.dottedName,
estimated: dottedName
}
let evaluatedNode = rewriteNode(
node,
nodeValue,
{
...evolve({ avec: map(recurse) }, v),
inversedWith: inversion?.inversedWith
},
missingVariables
)
// TODO - we need this so that ResultsGrid will work, but it's
// just not right
toPairs(inversion.inversionCache).map(([k, v]) => (cache[k] = v))
return evaluatedNode
}
return {
...v,
evaluate,
explanation: evolve({ avec: map(recurse) }, v),
jsx: InversionNumérique,
category: 'mecanism',
name: 'inversion numérique',
type: 'numeric'
}
}
export let mecanismSum = (recurse, k, v) => {
let explanation = v.map(recurse)
let evaluate = evaluateArray(add, 0)
return {
evaluate,
// eslint-disable-next-line
jsx: (nodeValue, explanation) => (
<Somme nodeValue={nodeValue} explanation={explanation} />
),
explanation,
category: 'mecanism',
name: 'somme',
type: 'numeric'
}
}
export let mecanismReduction = (recurse, k, v) => {
let objectShape = {
assiette: false,
abattement: defaultNode(0),
plafond: defaultNode(Infinity),
franchise: defaultNode(0)
}
let effect = ({ assiette, abattement, plafond, franchise, décote }) => {
let v_assiette = val(assiette)
if (v_assiette == null) return null
let montantFranchiséDécoté =
val(franchise) && v_assiette < val(franchise)
? 0
: décote
? do {
let plafondDécote = val(décote.plafond),
taux = val(décote.taux)
v_assiette > plafondDécote
? v_assiette
: max(0, (1 + taux) * v_assiette - taux * plafondDécote)
}
: v_assiette
return abattement
? val(abattement) == null
? montantFranchiséDécoté === 0
? 0
: null
: abattement.type === 'percentage'
? max(
0,
montantFranchiséDécoté - min(val(plafond), val(abattement) * montantFranchiséDécoté)
)
: max(0, montantFranchiséDécoté - min(val(plafond), val(abattement)))
: montantFranchiséDécoté
}
let base = parseObject(recurse, objectShape, v),
explanation = v.décote
? {
...base,
décote: map(recurse, v.décote)
}
: base,
evaluate = evaluateObject(objectShape, effect)
return {
evaluate,
jsx: Allègement,
explanation,
category: 'mecanism',
name: 'allègement',
type: 'numeric'
}
}
export let mecanismProduct = (recurse, k, v) => {
if (v.composantes) {
//mécanisme de composantes. Voir known-mecanisms.md/composantes
return decompose(recurse, k, v)
}
if (v.variations) {
return mecanismVariations(recurse, k, v, true)
}
let objectShape = {
assiette: false,
taux: defaultNode(1),
facteur: defaultNode(1),
plafond: defaultNode(Infinity)
}
let effect = ({ assiette, taux, facteur, plafond }) => {
let mult = (base, rate, facteur, plafond) =>
Math.min(base, plafond) * rate * facteur
return {
nodeValue:
val(taux) === 0 ||
val(taux) === false ||
val(assiette) === 0 ||
val(facteur) === 0
? 0
: anyNull([taux, assiette, facteur, plafond])
? null
: mult(val(assiette), val(taux), val(facteur), val(plafond)),
additionalExplanation: { plafondActif: val(assiette) > val(plafond) }
}
}
let explanation = parseObject(recurse, objectShape, v),
evaluate = evaluateObject(objectShape, effect)
return {
evaluate,
jsx: Product,
explanation,
category: 'mecanism',
name: 'multiplication',
type: 'numeric'
}
}
/* on réécrit en une syntaxe plus bas niveau mais plus régulière les tranches :
`en-dessous de: 1`
devient
```
de: 0
à: 1
```
*/
export let mecanismLinearScale = (recurse, k, v) => {
if (v.composantes) {
//mécanisme de composantes. Voir known-mecanisms.md/composantes
return decompose(recurse, k, v)
}
if (v.variations) {
return mecanismVariations(recurse, k, v, true)
}
let tranches = desugarScale(recurse)(v['tranches']),
objectShape = {
assiette: false,
multiplicateur: defaultNode(1)
}
let effect = ({ assiette, multiplicateur, tranches }) => {
if (val(assiette) === null) return null
let roundedAssiette = Math.round(val(assiette))
let matchedTranche = tranches.find(
({ de: min, à: max }) => roundedAssiette >= (val(multiplicateur) * min) && roundedAssiette <= (max * val(multiplicateur))
)
if (!matchedTranche) return 0
if (matchedTranche.taux)
return matchedTranche.taux.nodeValue * val(assiette)
return matchedTranche.montant
}
let explanation = {
...parseObject(recurse, objectShape, v),
tranches
},
evaluate = evaluateObject(objectShape, effect)
return {
evaluate,
jsx: Barème('linéaire'),
explanation,
category: 'mecanism',
name: 'barème linéaire',
barème: 'en taux',
type: 'numeric'
}
}
export let mecanismContinuousScale = (recurse, k, v) => {
let objectShape = {
assiette: false,
multiplicateur: defaultNode(1)
}
let returnRate = v['retourne seulement le taux'] === 'oui'
let effect = ({ assiette, multiplicateur, points }) => {
if (anyNull([assiette, multiplicateur])) return null
//We'll build a linear function given the two constraints that must be respected
let result = pipe(
toPairs,
// we don't rely on the sorting of objects
sort(([k1], [k2]) => k1 - k2),
points => [...points, [Infinity, last(points)[1]]],
aperture(2),
reduce((_, [[lowerLimit, lowerRate], [upperLimit, upperRate]]) => {
let x1 = val(multiplicateur) * lowerLimit,
x2 = val(multiplicateur) * upperLimit,
y1 = val(assiette) * val(recurse(lowerRate)),
y2 = val(assiette) * val(recurse(upperRate))
if (val(assiette) > x1 && val(assiette) <= x2) {
// Outside of these 2 limits, it's a linear function a * x + b
let a = (y2 - y1) / (x2 - x1),
b = y1 - x1 * a,
nodeValue = a * val(assiette) + b,
taux = nodeValue / val(assiette)
return reduced({
nodeValue: returnRate ? taux : nodeValue,
additionalExplanation: {
seuil: val(assiette) / val(multiplicateur),
taux
}
})
}
}, 0)
)(points)
return result
}
let explanation = {
...parseObject(recurse, objectShape, v),
points: v.points,
returnRate
},
evaluate = evaluateObject(objectShape, effect)
return {
evaluate,
jsx: BarèmeContinu,
explanation,
category: 'mecanism',
name: 'barème continu',
type: 'numeric'
}
}
export let mecanismMax = (recurse, k, v) => {
let explanation = v.map(recurse)
let evaluate = evaluateArray(max, Number.NEGATIVE_INFINITY)
let jsx = (nodeValue, explanation) => (
<Node
classes="mecanism list maximum"
name="le maximum de"
value={nodeValue}
child={
<ul>
{explanation.map((item, i) => (
<li key={i}>
<div className="description">{v[i].description}</div>
{makeJsx(item)}
</li>
))}
</ul>
}
/>
)
return {
evaluate,
jsx,
explanation,
type: 'numeric',
category: 'mecanism',
name: 'le maximum de'
}
}
export let mecanismMin = (recurse, k, v) => {
let explanation = v.map(recurse)
let evaluate = evaluateArray(min, Infinity)
let jsx = (nodeValue, explanation) => (
<Node
classes="mecanism list minimum"
name="le minimum de"
value={nodeValue}
child={
<ul>
{explanation.map((item, i) => (
<li key={i}>
<div className="description">{v[i].description}</div>
{makeJsx(item)}
</li>
))}
</ul>
}
/>
)
return {
evaluate,
jsx,
explanation,
type: 'numeric',
category: 'mecanism',
name: 'le minimum de'
}
}
export let mecanismComplement = (recurse, k, v) => {
if (v.composantes) {
//mécanisme de composantes. Voir known-mecanisms.md/composantes
return decompose(recurse, k, v)
}
let objectShape = { cible: false, montant: false }
let effect = ({ cible, montant }) => {
let nulled = val(cible) == null
return nulled ? null : subtract(val(montant), min(val(cible), val(montant)))
}
let explanation = parseObject(recurse, objectShape, v)
return {
evaluate: evaluateObject(objectShape, effect),
explanation,
type: 'numeric',
category: 'mecanism',
name: 'complément pour atteindre',
// eslint-disable-next-line
jsx: (nodeValue, explanation) => (
<Node
classes="mecanism list complement"
name="complément"
value={nodeValue}
child={
<ul className="properties">
<li key="cible">
<span className="key">
<Trans>cible</Trans>:{' '}
</span>
<span className="value">{makeJsx(explanation.cible)}</span>
</li>
<li key="mini">
<span className="key">
<Trans>montant à atteindre</Trans>:{' '}
</span>
<span className="value">{makeJsx(explanation.montant)}</span>
</li>
</ul>
}
/>
)
}
}
export let mecanismSynchronisation = (recurse, k, v) => {
let evaluate = (cache, situationGate, parsedRules, node) => {
let APIExplanation = evaluateNode(
cache,
situationGate,
parsedRules,
node.explanation.API
)
let valuePath = v.chemin.split(' . ')
let nodeValue =
val(APIExplanation) == null ? null : path(valuePath, val(APIExplanation))
// If the API gave a non null value, then some of its props may be null (the API can be composed of multiple API, some failing). Then this prop will be set to the default value defined in the API's rule
let safeNodeValue =
nodeValue == null && val(APIExplanation) != null
? path(valuePath, APIExplanation.explanation.defaultValue)
: nodeValue
let missingVariables =
val(APIExplanation) === null ? { [APIExplanation.dottedName]: 1 } : {}
let explanation = { ...v, API: APIExplanation }
return rewriteNode(node, safeNodeValue, explanation, missingVariables)
}
return {
explanation: { ...v, API: recurse(v.API) },
evaluate,
jsx: function Synchronisation(nodeValue, explanation) {
return (
<p>
Obtenu à partir de la saisie <SimpleRuleLink rule={explanation.API} />
</p>
)
},
category: 'mecanism',
name: 'synchronisation'
}
}
export let mecanismError = (recurse, k, v) => {
throw new Error("Le mécanisme '" + k + "' est inconnu !" + v)
}
export let mecanismOnePossibility = dottedName => (recurse, k, v) => ({
...v,
'une possibilité': 'oui',
evaluate: (cache, situationGate, parsedRules, node) => ({
...node,
missingVariables: { [dottedName]: 1 }
})
})