mon-entreprise/publicodes/docs/se-lancer.md

Installation

Publicodes est distribué sous la forme d'une librairie Node.js permettant de compiler un jeu de règles publicodes et de l'évaluer dans une situation donnée.

Le paquet est disponible sur npm :

$ npm install publicodes

Premiers pas

La bibliothèque exporte une classe par défaut Engine qui permet d'instancier le moteur avec un jeu de règles publicodes.

import Engine from 'publicodes'

// On définit une liste de règles publicodes
const rules = `
prix:
prix . carottes: 2€/kg
prix . champignons: 5€/kg
prix . avocat: 2€/avocat

dépenses primeur:
  formule: 
    somme:
      - prix . carottes * 1.5 kg
      - prix . champignons * 500g
      - prix . avocat * 3 avocat
`

// On initialise un moteur en lui donnant le publicodes.
// Ce publicodes va être parsé
const engine = new Engine(rules)

Note : importer sans bundler

Voici comment importer publicodes en fonction de l'environnement.

• Node >= 15.0.0

  import Engine from 'publicodes'
  

• Node < 15.0.0

  const Engine = require('publicodes').default
  

• ESModule sans npm install (<script type="module"> et deno)

  import Engine from 'https://unpkg.com/publicodes@next/esm/index.min.js'
  

• <script> dans navigateur

  <script src="https://unpkg.com/publicodes@next/dist/index.min.js"></script>
  <script>
      const Engine = window.publicodes.default
  </script>
  

La variable engine permet en ensuite de calculer la valeur d'une règle avec la méthode evaluate :

console.log(engine.evaluate('dépenses primeur'))

La valeur du nœud est disponible dans la propriété nodeValue, son unité est disponible dans la propriété unit. Mais pour un formattage sans effort, on préfèrera utiliser la fonction formatValue :

import Engine, { formatValue } from 'publicodes'
// ...
const dépenses = engine.evaluate('dépenses primeur')
console.log(`J'ai dépensé ${formatValue(dépenses)} chez le primeur.`)

La méthode setSituation permet de forcer la valeur d'une liste de règles. Elle est utile pour préciser les paramètres spécifiques à une simulation :

// Ici on change le prix des avocats
engine.setSituation({
    'prix . avocat': '3€/avocat',
})

La valeur de dépenses primeur se base maintenant sur un avocat à 3€ :

// On ré-évalue la règle dans la nouvelle situation
console.log(
    `Nouveau prix ! Dépenses mises à jour: ${formatValue(
        engine.evaluate('dépenses primeur')
    )}.`
)

Évaluation d'expressions

La fonction evaluate permet d'évaluer des expressions publicodes complètes :

// On va au marché une fois par semaine, amortissons la dépense sur 7 jours
const depensesParJour = engine.evaluate('dépenses primeur / 7 jours')
console.log(`J'ai dépensé ${formatValue(depensesParJour)}.`)

Conversion d'unité

Publicodes permet de réaliser des conversions d'unités. Pour celà il faut indiquer l'unité désirée via le mécanisme unité :

// on va au marché une fois par semaine en moyenne, combien dépense-t-on par mois ?
const depensesParMois = engine.evaluate({
    valeur: 'dépenses primeur / 7 jours',
    unité: '€/mois',
})
console.log(`J'ai dépensé ${formatValue(depensesParMois)}.`)

➡ en savoir plus sur les unités

Variables manquantes

Publicodes calcule automatiquement les dépendances de chaque règle. Si la valeur d'une dépendance est manquante et ne permet pas de faire le calcul, elle apparaîtra dans la propriété missingVariables :

const missingYEngine = new Engine(`
x: y + 5

y:
`)

console.log(missingYEngine.evaluate('x').missingVariables)

Cette information est utile pour intégrer publicodes à votre application.

Il est aussi possible d'utiliser des valeurs par défaut. Dans ce cas la règle sera calculée avec la valeur par défaut de sa dépendance, mais cette dernière apparaîtra tout de même dans les missingVariables. Cette fonctionnalité est utile pour réaliser des simulateurs où l'on veut proposer un résultat sans attendre que l'utilisateur ait répondu à l'intégralité des questions tout en utilisant la liste des variables manquantes pour déterminer les questions restant à poser.

Les variables manquantes sont calculées lors de l'évaluation. Si une variable apparaît dans la formule de calcul d'une règle elle ne sera rapportée que si elle est effectivement nécessaire au calcul. Si elle est présente dans une portion non active de l'évaluation (par exemple dans un bloc condition non actif, ou la tranche d'un barème non actif) elle sera filtrée et n'apparaîtra pas dans les missingVariables.

Documentation interactive

Publicodes génère également pour vous une documentation interactive, très facilement intégrable dans une app React. Pour cela, il vous suffit d'importer le composant dédié, et passer l'engine à afficher dans les props.

Il faut commencer par installer la librairie publicodes-react :

$ npm install publicodes-react

import { BrowserRouter as Router } from 'react-router-dom'
import { Documentation } from 'publicodes-react'

function MonApp() {
    return (
        <Router>
            <Documentation
                engine={engine}
                documentationPath={'/documentation'}
                language={'fr'}
            />
            {/* Composants de l'app */}
        </Router>
    )
}

Vous pourrez ensuite faire un lien vers la documentation avec le composant RuleLink.

import { RuleLink } from 'publicodes'

function MesDépenses() {
    return (
        <p>
            Accéder aux{' '}
            <RuleLink
                dottedName={'dépenses primeur'}
                engine={engine}
                documentationPath={'/documentation'}
            />
        </p>
    )
}