move undoableMoves into boolean inside long form move syntax

Author: nicolodavis

src/core/flow.js

@@ -48,11 +48,6 @@ import * as logging from './logger';
  *                                  Predicate to determine whether a
  *                                  particular move is allowed at
  *                                  this time.
- *
- * @param {...object} canUndoMove - (G, ctx, moveName) => boolean
- *                                  Predicate to determine whether a
- *                                  particular move is undoable at this
- *                                  time.
  */
 export function Flow({
   ctx,
@@ -183,9 +178,6 @@ export function Flow({
  *
  * @param {...object} setActionPlayers - Set to true to enable the `setActionPlayers` event.
  *
- * @param {...object} undoableMoves - List of moves that are undoable,
- *                                   (default: null, i.e. all moves are undoable).
- *
  * @param {...object} optimisticUpdate - (G, ctx, move) => boolean
  *                                       Control whether a move should
  *                                       be executed optimistically on
@@ -225,9 +217,6 @@ export function Flow({
  *
  *   // A phase-specific turn structure.
  *   turn: { ... },
- *
- *   // List of moves that are undoable.
- *   undoableMoves: ['moveA', ...],
  * }
  */
 export function FlowWithPhases({
@@ -240,8 +229,8 @@ export function FlowWithPhases({
   endPhase,
   endGame,
   setActionPlayers,
-  undoableMoves,
   optimisticUpdate,
+  getMove,
   game,
 }) {
   // Attach defaults.
@@ -267,7 +256,6 @@ export function FlowWithPhases({
   if (!endGameIf) endGameIf = () => undefined;
   if (!onMove) onMove = G => G;
   if (!turn) turn = {};
-  if (undoableMoves === undefined) undoableMoves = null;
 
   const phaseMap = game.phases || phases || {};
 
@@ -309,10 +297,6 @@ export function FlowWithPhases({
     }
     conf.onMove = plugins.FnWrap(conf.onMove, game);
 
-    if (conf.undoableMoves === undefined) {
-      conf.undoableMoves = undoableMoves;
-    }
-
     if (conf.turn === undefined) {
       conf.turn = turn;
     }
@@ -663,9 +647,17 @@ export function FlowWithPhases({
   };
 
   const canUndoMove = (G, ctx, moveName) => {
-    const conf = phaseMap[ctx.phase];
-    if (!conf.undoableMoves) return true;
-    return conf.undoableMoves.includes(moveName);
+    const move = getMove(moveName);
+
+    if (move.undoable === false) {
+      return false;
+    }
+
+    if (move.undoable instanceof Function) {
+      return move.undoable(G, ctx);
+    }
+
+    return true;
   };
 
   const events = {

src/core/flow.test.js

@@ -587,22 +587,27 @@ describe('endTurn / endPhase args', () => {
   });
 });
 
-test('undo / redo restricted by undoableMoves', () => {
+test('undoable moves', () => {
   const game = Game({
     moves: {
-      A: () => ({ A: true }),
-      B: () => ({ B: true }),
+      A: {
+        impl: () => ({ A: true }),
+        undoable: (G, ctx) => {
+          return ctx.phase == 'A';
+        },
+      },
+      B: {
+        impl: () => ({ B: true }),
+        undoable: false,
+      },
       C: () => ({ C: true }),
     },
 
     flow: {
-      undoableMoves: ['A', 'B'],
       startingPhase: 'A',
       phases: {
-        A: { undoableMoves: ['A'] },
-        B: { undoableMoves: ['B'] },
-        C: {},
-        D: { undoableMoves: null },
+        A: {},
+        B: {},
       },
     },
   });
@@ -622,7 +627,7 @@ test('undo / redo restricted by undoableMoves', () => {
   state = reducer(state, makeMove('C'));
   expect(state.G).toEqual({ C: true });
   state = reducer(state, undo());
-  expect(state.G).toEqual({ C: true });
+  expect(state.G).toEqual({ B: true });
 
   state.G = {};
   state = reducer(state, gameEvent('endPhase', { next: 'B' }));
@@ -636,47 +641,11 @@ test('undo / redo restricted by undoableMoves', () => {
   state = reducer(state, makeMove('B'));
   expect(state.G).toEqual({ B: true });
   state = reducer(state, undo());
-  expect(state.G).toEqual({ A: true });
-  state = reducer(state, makeMove('C'));
-  expect(state.G).toEqual({ C: true });
-  state = reducer(state, undo());
-  expect(state.G).toEqual({ C: true });
-
-  state.G = {};
-  state = reducer(state, gameEvent('endPhase', { next: 'C' }));
-  state = reducer(state, gameEvent('endTurn'));
-  expect(state.ctx.phase).toBe('C');
-
-  state = reducer(state, makeMove('A'));
-  expect(state.G).toEqual({ A: true });
-  state = reducer(state, undo());
-  expect(state.G).toEqual({});
-  state = reducer(state, makeMove('B'));
   expect(state.G).toEqual({ B: true });
-  state = reducer(state, undo());
-  expect(state.G).toEqual({});
   state = reducer(state, makeMove('C'));
   expect(state.G).toEqual({ C: true });
   state = reducer(state, undo());
-  expect(state.G).toEqual({ C: true });
-
-  state.G = {};
-  state = reducer(state, gameEvent('endPhase', { next: 'D' }));
-  state = reducer(state, gameEvent('endTurn'));
-  expect(state.ctx.phase).toBe('D');
-
-  state = reducer(state, makeMove('A'));
-  expect(state.G).toEqual({ A: true });
-  state = reducer(state, undo());
-  expect(state.G).toEqual({});
-  state = reducer(state, makeMove('B'));
   expect(state.G).toEqual({ B: true });
-  state = reducer(state, undo());
-  expect(state.G).toEqual({});
-  state = reducer(state, makeMove('C'));
-  expect(state.G).toEqual({ C: true });
-  state = reducer(state, undo());
-  expect(state.G).toEqual({});
 });
 
 test('endTurn is not called twice in one move', () => {

src/core/game.js

@@ -98,10 +98,6 @@ function Game(game) {
   if (game.playerView === undefined) game.playerView = G => G;
   if (game.plugins === undefined) game.plugins = [];
 
-  if (!game.flow || game.flow.processGameEvent === undefined) {
-    game.flow = FlowWithPhases({ game, ...game.flow });
-  }
-
   const getMove = name => {
     if (name in game.moves) {
       return game.moves[name];
@@ -114,6 +110,10 @@ function Game(game) {
     return null;
   };
 
+  if (!game.flow || game.flow.processGameEvent === undefined) {
+    game.flow = FlowWithPhases({ game, getMove, ...game.flow });
+  }
+
   return {
     ...game,