mana-scribe 1.0.1 → 1.1.0

package/README.md

@@ -14,6 +14,7 @@ Supports both brace `{3}{R/U}` and shortform `3R/U` notation.
   - Converted mana cost
   - Color identity
   - Devotion
+- Compare mana costs to evaluate if they are equal, greater than, or less than each other.
 - Extensible design — add new symbol types by subclassing
 
 Note: When the parser encounters an unrecognized symbol it stops parsing and returns the symbols it parsed so far.  You can access the unparsed string component through the property `remainingStr`.
@@ -44,8 +45,24 @@ console.log(cost.cmc);     // 3
 console.log(cost.colors);  // ['W','U','B']
 ```
 
+### Comparison example
+The `ManaCost` class supports equality and comparison operators under superset semantics:
+
+- `equals(other)` → true if the costs are exactly the same
+- `greaterThan(other)` → true if this cost includes all symbols of other plus additional ones, or generic mana cost is higher.
+- `lessThan(other)` → true if this cost is a strict subset of other, or generic mana cost is lower.
+
+```js
+const a = ManaCost.parse('{3}{B}{B}{B}');
+const b = ManaCost.parse('{1}{B}{B}{B}');
+
+console.log(a.equals(b));       // false
+console.log(a.greaterThan(b));  // true
+console.log(b.lessThan(a));     // true
+```
+
 ## Activation costs
-`ActivationCost` offers the same functionality as the `ManaCost` class, but supports additional symbols such as Tap, Untap, and Energy.
+`ActivationCost` offers the same functionality as the `ManaCost` class, but supports additional symbols such as Tap, Untap, and Energy.  It does not have comparison functions.
 
 ```js
 import { ActivationCost } from 'mana-scribe';
@@ -72,6 +89,7 @@ This is an early but complete implementation.
 Current priorities:
 - [x] Support core MTG symbols
 - [x] Add test coverage
+- [x] Add cost comparison
 - [ ] Other improvements? TBD
 
 ## License

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mana-scribe",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "description": "Library for parsing and querying Magic: The Gathering mana costs — with support for CMC, devotion, and color identity.",
   "keywords": [
     "mtg",
@@ -9,7 +9,6 @@
     "cost",
     "parser"
   ],
-  "homepage": "https://github.com/matortheeternal/mana-scribe#readme",
   "bugs": {
     "url": "https://github.com/matortheeternal/mana-scribe/issues"
   },

package/src/arrayComparison.js

@@ -0,0 +1,50 @@
+function toFrequencyMap(arr) {
+    const map = new Map();
+    for (const el of arr) {
+        if (el.type === 'genericMana' || el.type === 'infiniteMana') {
+            map.set('generic', (map.get('generic') || 0) + el.cmcValue());
+        } else {
+            const key = el.toString();
+            map.set(key, (map.get(key) || 0) + 1);
+        }
+    }
+    return map;
+}
+
+export function arrayEquals(arr1, arr2) {
+    const m1 = toFrequencyMap(arr1);
+    const m2 = toFrequencyMap(arr2);
+
+    if (m1.size !== m2.size) return false;
+    for (const [key, count] of m1.entries()) {
+        if ((m2.get(key) || 0) !== count) return false;
+    }
+    return true;
+}
+
+export function arrayGreaterThan(arr1, arr2) {
+    const m1 = toFrequencyMap(arr1);
+    const m2 = toFrequencyMap(arr2);
+
+    let larger = false;
+    for (const [key, count] of m2.entries()) {
+        if ((m1.get(key) || 0) < count) return false;
+        larger = larger || m1.get(key) > count;
+    }
+
+    return larger || m1.size > m2.size;
+}
+
+export function arrayLessThan(arr1, arr2) {
+    const m1 = toFrequencyMap(arr1);
+    const m2 = toFrequencyMap(arr2);
+
+    let smaller = false;
+    for (const [key, count] of m1.entries()) {
+        if ((m2.get(key) || 0) < count) return false;
+        smaller = smaller || (count < (m2.get(key) || 0));
+    }
+
+    return smaller || m1.size < m2.size;
+}
+

package/src/costs/ManaCost.js

@@ -13,6 +13,7 @@ import SnowManaSymbol from '../symbols/SnowManaSymbol.js';
 import ThreeColorHybridManaSymbol from '../symbols/ThreeColorHybridManaSymbol.js';
 import TwoColorHybridManaSymbol from '../symbols/TwoColorHybridManaSymbol.js';
 import VariableManaSymbol from '../symbols/VariableManaSymbol.js';
+import {arrayEquals, arrayGreaterThan, arrayLessThan} from '../arrayComparison.js';
 
 export default class ManaCost extends Cost {
     static get allowedSymbols() {
@@ -35,4 +36,16 @@ export default class ManaCost extends Cost {
             return devotion + (sym.colors.includes(color) ? 1 : 0);
         }, 0);
     }
+
+    equals(other) {
+        return arrayEquals(this.symbols, other.symbols);
+    }
+
+    greaterThan(other) {
+        return arrayGreaterThan(this.symbols, other.symbols);
+    }
+
+    lessThan(other) {
+        return arrayLessThan(this.symbols, other.symbols);
+    }
 }