Allow specifying the maximum iterations on exploding dice

dice-roller · Apr 22, 2021 · 7f8904e · 7f8904e
1 parent 2008fd5
commit 7f8904e
Show file tree

Hide file tree

Showing 13 changed files with 453 additions and 76 deletions.
diff --git a/src/modifiers/ComparisonModifier.js b/src/modifiers/ComparisonModifier.js
@@ -26,11 +26,12 @@ class ComparisonModifier extends Modifier {
    * Create a `ComparisonModifier` instance.
    *
    * @param {ComparePoint} [comparePoint] The comparison object
+   * @param {number|null} [limit=null] The maximum iteration limit per roll.
    *
    * @throws {TypeError} `comparePoint` must be an instance of `ComparePoint` or `undefined`
    */
-  constructor(comparePoint) {
-    super();
+  constructor(comparePoint, limit = null) {
+    super(limit);
 
     if (comparePoint) {
       this.comparePoint = comparePoint;

diff --git a/src/modifiers/ExplodeModifier.js b/src/modifiers/ExplodeModifier.js
@@ -19,11 +19,12 @@ class ExplodeModifier extends ComparisonModifier {
    * @param {ComparePoint} [comparePoint=null] The comparison object
    * @param {boolean} [compound=false] Whether to compound or not
    * @param {boolean} [penetrate=false] Whether to penetrate or not
+   * @param {number|null} [limit=null] The maximum iteration limit per roll.
    *
    * @throws {TypeError} comparePoint must be a `ComparePoint` object
    */
-  constructor(comparePoint = null, compound = false, penetrate = false) {
-    super(comparePoint);
+  constructor(comparePoint = null, compound = false, penetrate = false, limit = null) {
+    super(comparePoint, limit);
 
     this[compoundSymbol] = !!compound;
     this[penetrateSymbol] = !!penetrate;
@@ -58,7 +59,14 @@ class ExplodeModifier extends ComparisonModifier {
    * @returns {string}
    */
   get notation() {
-    return `!${this.compound ? '!' : ''}${this.penetrate ? 'p' : ''}${super.notation}`;
+    let notation = `!${this.compound ? '!' : ''}${this.penetrate ? 'p' : ''}`;
+
+    // if the max iterations has been changed, add it to the notation
+    if (this.maxIterations && (this.maxIterations !== this.constructor.defaultMaxIterations)) {
+      notation = `${notation}${this.maxIterations}`;
+    }
+
+    return `${notation}${super.notation}`;
   }
 
   /**
@@ -153,12 +161,13 @@ class ExplodeModifier extends ComparisonModifier {
    * }}
    */
   toJSON() {
-    const { compound, penetrate } = this;
+    const { compound, maxIterations, penetrate } = this;
 
     return Object.assign(
       super.toJSON(),
       {
         compound,
+        maxIterations,
         penetrate,
       },
     );

diff --git a/src/modifiers/KeepModifier.js b/src/modifiers/KeepModifier.js
@@ -96,6 +96,7 @@ class KeepModifier extends Modifier {
     if (value === Infinity) {
       throw new RangeError('qty must be a finite number');
     }
+
     if (!isNumeric(value) || (value < 1)) {
       throw new TypeError('qty must be a positive finite integer');
     }

diff --git a/src/modifiers/Modifier.js b/src/modifiers/Modifier.js
@@ -1,3 +1,7 @@
+import { isNumeric } from '../utilities/math.js';
+
+const maxIterationsSymbol = Symbol('max-iterations');
+
 /**
  * A `Modifier` is the base modifier class that all others extend from.
  *
@@ -10,8 +14,13 @@
 class Modifier {
   /**
    * Create a `Modifier` instance.
+   *
+   * @param {number|null} [limit=null] The maximum iteration limit per roll.
    */
-  constructor() {
+  constructor(limit = null) {
+    // set the maximum iteration limit
+    this.maxIterations = limit;
+
     // set the modifier's sort order
     this.order = 999;
   }
@@ -38,16 +47,48 @@ class Modifier {
   }
   /* eslint-enable class-methods-use-this */
 
-  /* eslint-disable class-methods-use-this */
   /**
-   * The maximum number of iterations that the modifier can apply to a single die roll
+   * The maximum number of iterations that the modifier can apply to a single die roll.
    *
-   * @returns {number} `1000`
+   * @returns {number}
    */
   get maxIterations() {
+    return this[maxIterationsSymbol];
+  }
+
+  /**
+   * Set the maximum number of iterations that the modifier can apply to a single die roll.
+   *
+   * @param {number} value
+   */
+  set maxIterations(value) {
+    const absoluteMax = this.constructor.defaultMaxIterations;
+
+    // if falsey, then set to the default max
+    if (!value && (value !== 0)) {
+      this[maxIterationsSymbol] = absoluteMax;
+      return;
+    }
+
+    if (!isNumeric(value)) {
+      throw new TypeError('maxIterations must be a number');
+    }
+
+    if ((value === Infinity) || (value < 1)) {
+      throw new RangeError(`maxIterations must be a number between 1 and ${absoluteMax}`);
+    }
+
+    this[maxIterationsSymbol] = Math.floor(Math.min(value, absoluteMax));
+  }
+
+  /**
+   * The default number of max iterations.
+   *
+   * @return {number}
+   */
+  static get defaultMaxIterations() {
     return 1000;
   }
-  /* eslint-enable class-methods-use-this */
 
   /* eslint-disable class-methods-use-this */
   /**

diff --git a/src/parser/grammars/grammar.pegjs b/src/parser/grammars/grammar.pegjs
@@ -62,8 +62,8 @@ Modifier
 
 // Explode, Penetrate, Compound modifier
 ExplodeModifier
-  = "!" compound:"!"? penetrate:"p"? comparePoint:ComparePoint? {
-    return new Modifiers.ExplodeModifier(comparePoint, !!compound, !!penetrate);
+  = "!" compound:"!"? penetrate:"p"? iterationLimit:IterationLimit? comparePoint:ComparePoint? {
+    return new Modifiers.ExplodeModifier(comparePoint, !!compound, !!penetrate, iterationLimit);
   }
 
 // Target / Success and Failure modifier
@@ -134,6 +134,8 @@ ComparePoint
 CompareOperator
   = "!=" / "<=" / ">=" / "=" / ">" / "<"
 
+IterationLimit = IntegerNumber
+
 
 /**
  * Mathematical

diff --git a/tests/RollGroup.test.js b/tests/RollGroup.test.js
@@ -286,13 +286,13 @@ describe('RollGroup', () => {
 
     test('modifiers list always returns in correct order', () => {
       // create modifiers and define their order
-      const mod1 = new Modifier('m1');
+      const mod1 = new Modifier();
       mod1.order = 4;
-      const mod2 = new Modifier('m2');
+      const mod2 = new Modifier();
       mod2.order = 3;
-      const mod3 = new Modifier('m3');
+      const mod3 = new Modifier();
       mod3.order = 1;
-      const mod4 = new Modifier('m4');
+      const mod4 = new Modifier();
       mod4.order = 2;
 
       // create the dice instance

diff --git a/tests/dice/FudgeDice.test.js b/tests/dice/FudgeDice.test.js
@@ -171,7 +171,7 @@ describe('FudgeDice', () => {
   describe('Modifiers', () => {
     test('setting modifiers in constructor calls setter', () => {
       const spy = jest.spyOn(FudgeDice.prototype, 'modifiers', 'set');
-      const modifiers = new Map(Object.entries({ foo: new Modifier('m') }));
+      const modifiers = new Map(Object.entries({ foo: new Modifier() }));
 
       new FudgeDice(null, 1, modifiers);
 
@@ -182,7 +182,7 @@ describe('FudgeDice', () => {
     });
 
     test('can set modifiers with Map', () => {
-      const modifiers = new Map(Object.entries({ foo: new Modifier('m') }));
+      const modifiers = new Map(Object.entries({ foo: new Modifier() }));
       const die = new FudgeDice(null, 1);
 
       die.modifiers = modifiers;
@@ -192,7 +192,7 @@ describe('FudgeDice', () => {
     });
 
     test('can set modifiers with Object', () => {
-      const modifier = new Modifier('m');
+      const modifier = new Modifier();
       const die = new FudgeDice(null, 1);
 
       die.modifiers = { foo: modifier };
@@ -202,7 +202,7 @@ describe('FudgeDice', () => {
     });
 
     test('can set modifiers with Array', () => {
-      const modifiers = [new Modifier('m')];
+      const modifiers = [new Modifier()];
       const die = new FudgeDice(null, 1);
 
       die.modifiers = modifiers;
@@ -238,13 +238,13 @@ describe('FudgeDice', () => {
 
     test('modifiers list always returns in correct order', () => {
       // create modifiers and define their order
-      const mod1 = new Modifier('m1');
+      const mod1 = new Modifier();
       mod1.order = 4;
-      const mod2 = new Modifier('m2');
+      const mod2 = new Modifier();
       mod2.order = 3;
-      const mod3 = new Modifier('m3');
+      const mod3 = new Modifier();
       mod3.order = 1;
-      const mod4 = new Modifier('m4');
+      const mod4 = new Modifier();
       mod4.order = 2;
 
       // create the dice instance

diff --git a/tests/dice/PercentileDice.test.js b/tests/dice/PercentileDice.test.js
@@ -104,7 +104,7 @@ describe('PercentileDice', () => {
   describe('Modifiers', () => {
     test('setting modifiers in constructor calls setter', () => {
       const spy = jest.spyOn(PercentileDice.prototype, 'modifiers', 'set');
-      const modifiers = new Map(Object.entries({ foo: new Modifier('m') }));
+      const modifiers = new Map(Object.entries({ foo: new Modifier() }));
 
       new PercentileDice(1, modifiers);
 
@@ -115,7 +115,7 @@ describe('PercentileDice', () => {
     });
 
     test('can set modifiers with Map', () => {
-      const modifiers = new Map(Object.entries({ foo: new Modifier('m') }));
+      const modifiers = new Map(Object.entries({ foo: new Modifier() }));
       const die = new PercentileDice();
 
       die.modifiers = modifiers;
@@ -125,7 +125,7 @@ describe('PercentileDice', () => {
     });
 
     test('can set modifiers with Object', () => {
-      const modifier = new Modifier('m');
+      const modifier = new Modifier();
       const die = new PercentileDice(1);
 
       die.modifiers = { foo: modifier };
@@ -135,7 +135,7 @@ describe('PercentileDice', () => {
     });
 
     test('can set modifiers with Array', () => {
-      const modifiers = [new Modifier('m')];
+      const modifiers = [new Modifier()];
       const die = new PercentileDice(1);
 
       die.modifiers = modifiers;
@@ -171,13 +171,13 @@ describe('PercentileDice', () => {
 
     test('modifiers list always returns in correct order', () => {
       // create modifiers and define their order
-      const mod1 = new Modifier('m1');
+      const mod1 = new Modifier();
       mod1.order = 4;
-      const mod2 = new Modifier('m2');
+      const mod2 = new Modifier();
       mod2.order = 3;
-      const mod3 = new Modifier('m3');
+      const mod3 = new Modifier();
       mod3.order = 1;
-      const mod4 = new Modifier('m4');
+      const mod4 = new Modifier();
       mod4.order = 2;
 
       // create the dice instance

diff --git a/tests/dice/StandardDice.test.js b/tests/dice/StandardDice.test.js
@@ -393,7 +393,7 @@ describe('StandardDice', () => {
   describe('Modifiers', () => {
     test('setting modifiers in constructor calls setter', () => {
       const spy = jest.spyOn(StandardDice.prototype, 'modifiers', 'set');
-      const modifiers = new Map(Object.entries({ foo: new Modifier('m') }));
+      const modifiers = new Map(Object.entries({ foo: new Modifier() }));
 
       new StandardDice(6, 8, modifiers);
 
@@ -405,7 +405,7 @@ describe('StandardDice', () => {
     });
 
     test('can set modifiers with Map', () => {
-      const modifiers = new Map(Object.entries({ foo: new Modifier('m') }));
+      const modifiers = new Map(Object.entries({ foo: new Modifier() }));
       const die = new StandardDice(6, 8);
 
       die.modifiers = modifiers;
@@ -415,7 +415,7 @@ describe('StandardDice', () => {
     });
 
     test('can set modifiers with Object', () => {
-      const modifier = new Modifier('m');
+      const modifier = new Modifier();
       const die = new StandardDice(6, 8);
 
       die.modifiers = { foo: modifier };
@@ -425,7 +425,7 @@ describe('StandardDice', () => {
     });
 
     test('can set modifiers with Array', () => {
-      const modifiers = [new Modifier('m')];
+      const modifiers = [new Modifier()];
       const die = new StandardDice(6, 8);
 
       die.modifiers = modifiers;
@@ -461,13 +461,13 @@ describe('StandardDice', () => {
 
     test('modifiers list always returns in correct order', () => {
       // create modifiers and define their order
-      const mod1 = new Modifier('m1');
+      const mod1 = new Modifier();
       mod1.order = 4;
-      const mod2 = new Modifier('m2');
+      const mod2 = new Modifier();
       mod2.order = 3;
-      const mod3 = new Modifier('m3');
+      const mod3 = new Modifier();
       mod3.order = 1;
-      const mod4 = new Modifier('m4');
+      const mod4 = new Modifier();
       mod4.order = 2;
 
       // create the dice instance