Merge branch 'main' into improvement/test-updates

.github/workflows/main.yml

@@ -0,0 +1,31 @@
+# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: Node.js CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build-and-test:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [20]
+        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v4
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'yarn'
+    - run: yarn --frozen-lockfile
+    - run: yarn run build
+    - run: yarn run test

src/models/Chemistry.ts

@@ -121,6 +121,7 @@ const STARTING_RESPONSE: (options?: ChemistryOptions, coefficientScalingValue?:
     isEqual: true,
     typeMismatch: false,
     sameCoefficient: true,
+    sameHydrate: true,
     sameElements: true,
     sameState: true,
     sameHydrate: true,
@@ -427,7 +428,7 @@ function checkNodesEqual(test: ASTNode, target: ASTNode, response: CheckerRespon
             const comparator = (test: [Molecule, number], target: [Molecule, number], response: CheckerResponse): CheckerResponse => {
                 const newResponse = checkNodesEqual(test[0], target[0], response);
                 newResponse.sameCharge = newResponse.sameCharge && test[1] === target[1];
-                newResponse.isEqual = newResponse.isEqual && (newResponse.sameCharge === true);
+                newResponse.isEqual = newResponse.isEqual && (newResponse.sameCharge ?? true);
 
                 if (!test[0].bracketed) {
                     // If not bracketed, add the charge directly to the chargeCount of the term
@@ -610,7 +611,7 @@ export function check(test: ChemAST, target: ChemAST, options: ChemistryOptions)
 
     let newResponse = checkNodesEqual(test.result, target.result, response);
     // We set flags for these properties in checkNodesEqual, but we only apply the isEqual check here due to listComparison
-    newResponse.isEqual = newResponse.isEqual && newResponse.sameCoefficient && (newResponse.sameState === true) && (newResponse.sameBrackets === true) && (newResponse.sameHydrate === true);
+    newResponse.isEqual = newResponse.isEqual && newResponse.sameCoefficient && (newResponse.sameState ?? true) && (newResponse.sameBrackets ?? true) && (newResponse.sameHydrate ?? true);
 
     if (!newResponse.options?.keepAggregates) {
         newResponse = removeAggregates(newResponse);

src/models/Nuclear.ts

@@ -226,7 +226,7 @@ function checkNodesEqual(test: ASTNode, target: ASTNode, response: CheckerRespon
         response.validAtomicNumber = (response.validAtomicNumber ?? true) && isValidAtomicNumber(test) && (response.sameElements ? test.mass === target.mass && test.atomic === target.atomic : true);
         response.isEqual = response.isEqual && response.sameElements && response.validAtomicNumber;
 
-        // Add the term's nucleon counts to the term's nucleon count
+        // Add the isotope's nucleon counts to the term's nucleon count
         if (response.termNucleonCount) {
             response.termNucleonCount = [
                 response.termNucleonCount[0] + test.atomic,

src/models/common.ts

@@ -61,6 +61,8 @@ export function mergeResponses(response1: CheckerResponse, response2: CheckerRes
     newResponse.sameCoefficient = response1.sameCoefficient && response2.sameCoefficient;
     newResponse.sameElements = response1.sameElements && response2.sameElements;
     if (!response1.isNuclear) {
+        newResponse.sameCharge = response1.sameCharge && response2.sameCharge;
+        newResponse.sameHydrate = response1.sameHydrate && response2.sameHydrate;
         newResponse.sameState = response1.sameState && response2.sameState;
         newResponse.sameBrackets = response1.sameBrackets && response2.sameBrackets;
     } else {
@@ -128,13 +130,14 @@ export function listComparison<T>(
             returnResponse.isEqual = false;
 
             // Attach actual aggregate values
+            returnResponse.bracketChargeCount = aggregatesResponse.bracketChargeCount;
+            returnResponse.termChargeCount = aggregatesResponse.termChargeCount;
             returnResponse.chargeCount = aggregatesResponse.chargeCount;
             returnResponse.bracketAtomCount = aggregatesResponse.bracketAtomCount;
             returnResponse.termAtomCount = aggregatesResponse.termAtomCount;
             returnResponse.atomCount = aggregatesResponse.atomCount;
-            if (aggregatesResponse.nucleonCount) {
-                returnResponse.nucleonCount = aggregatesResponse.nucleonCount;
-            }
+            returnResponse.termNucleonCount = aggregatesResponse.termNucleonCount;
+            returnResponse.nucleonCount = aggregatesResponse.nucleonCount;
 
             return returnResponse;
         }