refactor: CarSimulatorEngine -> CarSimulator

Author: EmileRolley

src/CarSimulatorEngine.ts renamed to src/CarSimulator.ts

@@ -94,7 +94,7 @@ export const ALTERNATIVES_RULES = RULE_NAMES.filter(
  * can use {@link shallowCopy} to create a new instance with the same rules and
  * inputs.
  */
-export class CarSimulatorEngine {
+export class CarSimulator {
   private inputs: Questions = {}
   private engine: Engine<RuleName>
 
@@ -271,7 +271,7 @@ export class CarSimulatorEngine {
    * @returns A new instance of the engine with the same rules and inputs.
    */
   public shallowCopy() {
-    const newEngine = new CarSimulatorEngine(true)
+    const newEngine = new CarSimulator(true)
     newEngine.inputs = { ...this.inputs }
     newEngine.engine = this.engine.shallowCopy()
     return newEngine

src/index.ts

@@ -9,4 +9,4 @@ export type {
   RuleValue,
 } from "../publicodes-build"
 
-export * from "./CarSimulatorEngine"
+export * from "./CarSimulator"

test/CarSimulatorEngine.test.ts renamed to test/CarSimulator.test.ts

@@ -1,19 +1,19 @@
 import { describe, expect, test } from "vitest"
-import { CarSimulatorEngine } from "../src/CarSimulatorEngine"
+import { CarSimulator } from "../src/CarSimulator"
 
-describe("CarSimulatorEngine", () => {
-  describe("new CarSimulatorEngine()", () => {
+describe("CarSimulator", () => {
+  describe("new CarSimulator()", () => {
     test("should return an instance of AidesVeloEngine with corrects rules parsed", () => {
-      const engine = new CarSimulatorEngine()
-      expect(engine).toBeInstanceOf(CarSimulatorEngine)
+      const engine = new CarSimulator()
+      expect(engine).toBeInstanceOf(CarSimulator)
 
       const parsedRules = engine.getEngine().getParsedRules()
       expect(parsedRules["coûts"]).toBeDefined()
       expect(parsedRules["empreinte"]).toBeDefined()
     })
   })
 
-  const globalTestEngine = new CarSimulatorEngine()
+  const globalTestEngine = new CarSimulator()
 
   describe("setInputs()", () => {
     test("should correctly set the engine's situation", () => {
@@ -195,9 +195,7 @@ describe("CarSimulatorEngine", () => {
   describe("evaluateAlternatives()", () => {
     test("should return all possible alternatives with default values", () => {
       const engine = globalTestEngine.shallowCopy()
-      console.time("evaluateAlternatives")
       const alternatives = engine.evaluateAlternatives()
-      console.timeEnd("evaluateAlternatives")
       // TODO: use engine.getOptions
       const nbMotorisations = 3
       const nbFuels = 4
@@ -218,8 +216,8 @@ describe("CarSimulatorEngine", () => {
         expect(alternative.motorisation.value).toBeDefined()
         expect(alternative.motorisation.isEnumValue).toBeTruthy()
         if (alternative.motorisation.value !== "électrique") {
-          expect(alternative.fuel.value).toBeDefined()
-          expect(alternative.fuel.isEnumValue).toBeTruthy()
+          expect(alternative.fuel?.value).toBeDefined()
+          expect(alternative.fuel?.isEnumValue).toBeTruthy()
         } else {
           expect(alternative.fuel).toBeUndefined()
         }