feat(range): delegate RangeToken calculations to the bignumber.js

fix: rounding issues (#1, #3)
tests: refine tests (remove `it.each` when possible), add #3 test case

Closes: #3

Author: Mathieu Bour

.standard-commitrc.json

@@ -0,0 +1,5 @@
+{
+  "types": ["feat", "fix", "chore", "build", "ci", "docs", "perf", "refactor", "revert", "style", "test"],
+  "promptScope": "suggest",
+  "scopes": "staged"
+}

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## [Version 0.2.0](https://github.com/csquare-ai/crossp/releases/tag/0.2.0)
+
+- **feat**: delegate `RangeToken` calculations to the `bignumber.js` library
+- **fix**: rounding issues ([#1](https://github.com/csquare-ai/crossp/issues/1), [#3](https://github.com/csquare-ai/crossp/issues/3))
+- **tests**: refine tests (remove `it.each` when possible), add [#3](https://github.com/csquare-ai/crossp/issues/3) test case
+
 ## [Version 0.1.2 - Fix types directory](https://github.com/csquare-ai/crossp/releases/tag/0.1.2)
 
 - **fix**: set types directory to `dist/types`

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@csquare/crossp",
-  "version": "0.1.2",
+  "version": "0.2.0",
   "description": "Generate commands from a single one using csquare syntax.",
   "keywords": [
     "csquare",
@@ -53,5 +53,8 @@
   "engines": {
     "node": ">=10"
   },
-  "prettier": "@csquare/prettier-config"
+  "prettier": "@csquare/prettier-config",
+  "dependencies": {
+    "bignumber.js": "^9.0.1"
+  }
 }

package.json

@@ -32,12 +32,11 @@ export function crossp(command: string): string[] {
   }
 
   const replacements = cartesian(...tokens.map((t) => t.values));
-  const truncRegex = /(?!\d*\..)0{2}\d*/g;
   const result: string[] = replacements.map((line) => {
     let acc = work;
 
     line.forEach((value, index) => {
-      acc = acc.replace(placeholder(index), value.replace(truncRegex, ''));
+      acc = acc.replace(placeholder(index), value);
     });
 
     return acc;

src/crossp.ts

@@ -2,4 +2,5 @@ import crossp from './crossp';
 
 // Public package API
 export { crossp } from './crossp';
+export { limits } from './limits';
 export default crossp;

src/index.ts

@@ -1,16 +1,18 @@
+import { limits } from '../limits';
+
 /**
  * @see https://stackoverflow.com/a/43053803/3728261
  */
-import { limits } from '../limits';
-
 export default function cartesian(...values: string[][]): string[][] {
   // @ts-ignore
   let out: string[][] = values.reduce((matrix: string[][], current: string[]) => {
-    if (matrix.length > limits.outputs) {
+    const result = matrix.flatMap((d: string | string[]) => current.map((e: string) => [d, e].flat()));
+
+    if (result.length > limits.outputs) {
       throw new RangeError(`Command exceeds the maximum of ${limits.outputs} outputs`);
     }
 
-    return matrix.flatMap((d: string | string[]) => current.map((e: string) => [d, e].flat()));
+    return result;
   });
 
   if (out?.[0] && typeof out[0] === 'string') {

src/lib/cartesian.ts

@@ -1,11 +1,12 @@
+import BigNumber from 'bignumber.js';
 import { limits } from '../limits';
 import { Token } from './token';
 
 export class RangeToken implements Token {
   private readonly FLOAT_REGEX = /[+-]?(?:\d*[.])?\d+/;
-  readonly start: number;
-  readonly end: number;
-  readonly increment: number;
+  readonly start: BigNumber;
+  readonly end: BigNumber;
+  readonly increment: BigNumber;
   readonly values: string[] = [];
 
   constructor(readonly raw: string) {
@@ -23,27 +24,27 @@ export class RangeToken implements Token {
       throw new SyntaxError('Non numeric range parameters');
     }
 
-    this.start = parseFloat(parts[0]);
-    this.end = parseFloat(parts[1]);
-    this.increment = Math.abs(parts?.[2] && parts[2].length > 0 ? parseFloat(parts[2]) : 1);
+    this.start = new BigNumber(parts[0]);
+    this.end = new BigNumber(parts[1]);
+    this.increment = parts?.[2] && parts[2].length > 0 ? new BigNumber(parts[2]).abs() : new BigNumber(1);
 
-    if (this.increment === 0) {
+    if (this.increment.eq(0)) {
       throw new RangeError('Increment cannot be equal to zero');
     }
 
-    if (this.start > this.end) {
+    if (this.start.gt(this.end)) {
       [this.start, this.end] = [this.end, this.start];
     }
 
-    if ((this.end - this.start) / this.increment > limits.range) {
+    if (this.end.minus(this.start).div(this.increment).gt(limits.range)) {
       throw new RangeError(`Range operator exceeds the maximum allowed domain of ${limits.range} values`);
     }
 
-    let current = this.start;
+    let current = new BigNumber(this.start);
 
-    while (current <= this.end) {
+    while (current.lte(this.end)) {
       this.values.push(current.toString(10));
-      current += this.increment;
+      current = current.plus(this.increment);
     }
   }
 }

src/tokens/range-token.ts

@@ -93,28 +93,47 @@ describe('compiler', () => {
     ],
   ])('should compile %p using multi-statements', expectToEqual);
 
-  it.each([
-    ['python train.py --epochs=%[]%', 'Empty comma-separated list'],
-    ['python train.py --epochs=%(10,%[1,2,3]%,2)%', 'Invalid number of arguments for range'],
-    ['python train.py --epochs=%(in,out,1)%', 'Non numeric range parameters'],
-    ['python train.py --epochs=%(1,10,0)%', 'Increment cannot be equal to zero'],
-  ])('should throw a syntax error for %p', expectToThrow);
+  it('should throw if there is an empty comma-separated list', () => {
+    expectToThrow('python train.py --epochs=%[]%', 'Empty comma-separated list');
+  });
 
-  it.each([
-    [
+  it('should throw if there is invalid arguments for the range operator', () => {
+    expectToThrow('python train.py --epochs=%(10,%[1,2,3]%,2)%', 'Invalid number of arguments for range');
+  });
+
+  it('should throw if the range operator get non-numeric operators', () => {
+    expectToThrow('python train.py --epochs=%(in,out,1)%', 'Non numeric range parameters');
+  });
+
+  it('should throw if the range operator is equal to zero', () => {
+    expectToThrow('python train.py --epochs=%(1,10,0)%', 'Increment cannot be equal to zero');
+  });
+
+  it(`should throw if a range operator exceeds the maximum allowed domain of ${limits.range} values`, () => {
+    expectToThrow(
+      'python train.py --foo=%(0,1,0.0000001)%',
+      `Range operator exceeds the maximum allowed domain of ${limits.range} values`,
+    );
+  });
+
+  it(`should throw if the command generate more than the allowed limit of ${limits.outputs} outputs`, () => {
+    expectToThrow(
+      'python train.py --foo=%(0,100)% --bar=%(0,100)% --baz%(0,100)%',
+      `Command exceeds the maximum of ${limits.outputs} outputs`,
+    );
+  });
+
+  it(`should throw if the command exceeds the maximum allowed length of ${limits.length} characters`, () => {
+    expectToThrow(
       `python train.py ${new Array(limits.length * 2).join('#')}`,
       `Command exceeds the maximum allowed length of ${limits.length} characters`,
-    ],
-    [
-      'python train.py --foo=%(0,1,0.000001)%',
-      `Range operator exceeds the maximum allowed domain of ${limits.range} values`,
-    ],
-  ])('should not compile %p and be rate limited', expectToThrow);
+    );
+  });
 
   /**
    * @link https://github.com/csquare-ai/crossp/issues/1
    */
-  it('should not have round issues', () => {
+  it('should not have rounding issues with %(0.1,0.5,0.1)%', () => {
     expectToEqual('python --train.py --lr=%(0.1,0.5,0.1)%', [
       'python --train.py --lr=0.1',
       'python --train.py --lr=0.2',
@@ -123,4 +142,22 @@ describe('compiler', () => {
       'python --train.py --lr=0.5',
     ]);
   });
+
+  /**
+   * @link https://github.com/csquare-ai/crossp/issues/3
+   */
+  it('should not have rounding issues with %(10,100,10)%', () => {
+    expectToEqual('python --train.py --lr=%(10,100,10)%', [
+      'python --train.py --lr=10',
+      'python --train.py --lr=20',
+      'python --train.py --lr=30',
+      'python --train.py --lr=40',
+      'python --train.py --lr=50',
+      'python --train.py --lr=60',
+      'python --train.py --lr=70',
+      'python --train.py --lr=80',
+      'python --train.py --lr=90',
+      'python --train.py --lr=100',
+    ]);
+  });
 });