test.ca.odell.glazedlists.UndoRedoSupportTest Maven / Gradle / Ivy

Go to download
/* Glazed Lists                                                 (c) 2003-2006 */
/* http://publicobject.com/glazedlists/                      publicobject.com,*/
/*                                                     O'Dell Engineering Ltd.*/
package ca.odell.glazedlists;

import junit.framework.TestCase;

import java.util.*;

import ca.odell.glazedlists.event.ListEvent;

public class UndoRedoSupportTest extends TestCase {

    private EventList source;
    private TransactionList nestedSource;
    private UndoRedoSupport undoRedoSupport;
    private UndoSupportWatcher undoSupportWatcher;

    protected void setUp() {
        source = new BasicEventList();
        nestedSource = new TransactionList(source, true);
        undoRedoSupport = UndoRedoSupport.install(nestedSource);
        undoSupportWatcher = new UndoSupportWatcher();

        undoRedoSupport.addUndoSupportListener(undoSupportWatcher);
    }

    protected void tearDown() {
        source = null;
        nestedSource = null;
        undoRedoSupport = null;
        undoSupportWatcher = null;
    }

    public void testAdd() {
        source.add("First");
        assertEquals(1, undoSupportWatcher.getEditStack().size());

        UndoRedoSupport.Edit lastEdit = undoSupportWatcher.getEditStack().remove(0);
        assertTrue(lastEdit.canUndo());
        assertFalse(lastEdit.canRedo());
        assertEquals(1, source.size());

        lastEdit.undo();
        assertFalse(lastEdit.canUndo());
        assertTrue(lastEdit.canRedo());
        assertEquals(0, source.size());
        assertEquals(0, undoSupportWatcher.getEditStack().size());

        lastEdit.redo();
        assertTrue(lastEdit.canUndo());
        assertFalse(lastEdit.canRedo());
        assertEquals(1, source.size());
        assertSame("First", source.get(0));
        assertEquals(0, undoSupportWatcher.getEditStack().size());
    }

    public void testRemove() {
        source.add("First");
        undoSupportWatcher.getEditStack().remove(0);
        source.remove(0);
        assertEquals(1, undoSupportWatcher.getEditStack().size());

        UndoRedoSupport.Edit lastEdit = undoSupportWatcher.getEditStack().remove(0);
        assertTrue(lastEdit.canUndo());
        assertFalse(lastEdit.canRedo());
        assertEquals(0, source.size());

        lastEdit.undo();
        assertFalse(lastEdit.canUndo());
        assertTrue(lastEdit.canRedo());
        assertEquals(1, source.size());
        assertSame("First", source.get(0));
        assertEquals(0, undoSupportWatcher.getEditStack().size());

        lastEdit.redo();
        assertTrue(lastEdit.canUndo());
        assertFalse(lastEdit.canRedo());
        assertEquals(0, source.size());
        assertEquals(0, undoSupportWatcher.getEditStack().size());
    }

    public void testUpdate() {
        source.add("First");
        undoSupportWatcher.getEditStack().remove(0);
        source.set(0, "Second");
        assertEquals(1, undoSupportWatcher.getEditStack().size());

        UndoRedoSupport.Edit lastEdit = undoSupportWatcher.getEditStack().remove(0);
        assertTrue(lastEdit.canUndo());
        assertFalse(lastEdit.canRedo());
        assertEquals(1, source.size());

        lastEdit.undo();
        assertFalse(lastEdit.canUndo());
        assertTrue(lastEdit.canRedo());
        assertEquals(1, source.size());
        assertSame("First", source.get(0));
        assertEquals(0, undoSupportWatcher.getEditStack().size());

        lastEdit.redo();
        assertTrue(lastEdit.canUndo());
        assertFalse(lastEdit.canRedo());
        assertEquals(1, source.size());
        assertSame("Second", source.get(0));
        assertEquals(0, undoSupportWatcher.getEditStack().size());
    }

    public void testMutate() {
        source.add("First");
        undoSupportWatcher.getEditStack().remove(0);
        source.set(0, "First");
        assertEquals(0, undoSupportWatcher.getEditStack().size());
    }

    public void testComplexEdit() {
        source.add("First");
        source.add("Second");
        source.add("Third");
        source.add("Fourth");
        source.add("Fifth");

        final List beforeSnapshot = new ArrayList(source);
        undoSupportWatcher.getEditStack().clear();
        assertEquals(0, undoSupportWatcher.getEditStack().size());

        nestedSource.beginEvent();
        nestedSource.add(5, "Sixth");
        nestedSource.remove(2);
        nestedSource.set(3, "Updated");
        nestedSource.commitEvent();

        final List afterSnapshot = new ArrayList(source);

        assertEquals(1, undoSupportWatcher.getEditStack().size());
        UndoRedoSupport.Edit lastEdit = undoSupportWatcher.getEditStack().remove(0);
        assertTrue(lastEdit.canUndo());
        assertFalse(lastEdit.canRedo());
        assertSame("First", source.get(0));
        assertSame("Second", source.get(1));
        assertSame("Fourth", source.get(2));
        assertSame("Updated", source.get(3));
        assertSame("Sixth", source.get(4));
        assertEquals(0, undoSupportWatcher.getEditStack().size());

        lastEdit.undo();
        assertEquals(beforeSnapshot, source);
        assertEquals(0, undoSupportWatcher.getEditStack().size());

        lastEdit.redo();
        assertEquals(afterSnapshot, source);
        assertEquals(0, undoSupportWatcher.getEditStack().size());

        lastEdit.undo();
        assertEquals(beforeSnapshot, source);
        assertEquals(0, undoSupportWatcher.getEditStack().size());

        lastEdit.redo();
        assertEquals(afterSnapshot, source);
        assertEquals(0, undoSupportWatcher.getEditStack().size());
    }

    public void testLongChainOfRandomEdits() {
        int value = 0;
        Random random = new Random();

        // create a series of 500 changes
        for (int i = 0; i < 500; i++) {
            int changeType = nestedSource.isEmpty() ? ListEvent.INSERT : random.nextInt(3);
            int index = nestedSource.isEmpty() ? 0 : random.nextInt(nestedSource.size());

            if (changeType == ListEvent.INSERT)
                nestedSource.add(index, String.valueOf(++value));
            else if (changeType == ListEvent.DELETE)
                nestedSource.remove(index);
            else if (changeType == ListEvent.UPDATE)
                nestedSource.set(index, String.valueOf(++value));
        }

        // take a snapshot of the List after 500 random edits
        final List snapshot = new ArrayList(nestedSource);
        assertEquals(500, undoSupportWatcher.getEditStack().size());

        // undo all edits (should result in an empty list)
        final ListIterator i = undoSupportWatcher.getEditStack().listIterator();
        while (i.hasNext())
            i.next().undo();

        assertTrue(nestedSource.isEmpty());

        // redo all edits (should result in snapshot)
        while (i.hasPrevious())
            i.previous().redo();

        assertEquals(snapshot, nestedSource);
    }

    private static class UndoSupportWatcher implements UndoRedoSupport.Listener {
        private List editStack = new ArrayList();

        public void undoableEditHappened(UndoRedoSupport.Edit edit) {
            editStack.add(0, edit);
        }

        public List getEditStack() { return editStack; }
    }
}