mirror of
https://github.com/DesignPatternsPHP/DesignPatternsPHP.git
synced 2025-08-13 02:14:04 +02:00
Memento pattern.
- Caretaker should save history for normal pattern implementation. - Importent notes in code of Originator. - Readme with full pattern philosophy. - Tests and example of usage inside test.
This commit is contained in:
@@ -2,6 +2,8 @@
|
||||
|
||||
namespace DesignPatterns\Behavioral\Memento\Tests;
|
||||
|
||||
use DesignPatterns\Behavioral\Memento\Caretaker;
|
||||
use DesignPatterns\Behavioral\Memento\Memento;
|
||||
use DesignPatterns\Behavioral\Memento\Originator;
|
||||
|
||||
/**
|
||||
@@ -10,6 +12,37 @@ use DesignPatterns\Behavioral\Memento\Originator;
|
||||
class MementoTest extends \PHPUnit_Framework_TestCase
|
||||
{
|
||||
|
||||
public function testUsageExample()
|
||||
{
|
||||
$originator = new Originator();
|
||||
$caretaker = new Caretaker();
|
||||
|
||||
$character = new \stdClass();
|
||||
$character->name = "Gandalf"; // new object
|
||||
$originator->setState($character); // connect Originator to character object
|
||||
|
||||
$character->name = "Gandalf the Grey"; // work on the object
|
||||
$character->race = "Maia"; // still change something
|
||||
$snapshot = $originator->getStateAsMemento(); // time to save state
|
||||
$caretaker->saveToHistory($snapshot); // put state to log
|
||||
|
||||
$character->name = "Sauron"; // change something
|
||||
$character->race = "Ainur"; // and again
|
||||
$this->assertAttributeEquals($character, "state", $originator); // state inside the Originator was equally changed
|
||||
|
||||
$snapshot = $originator->getStateAsMemento(); // time to save another state
|
||||
$caretaker->saveToHistory($snapshot); // put state to log
|
||||
|
||||
$rollback = $caretaker->getFromHistory(0);
|
||||
$originator->restoreFromMemento($rollback); // return to first state
|
||||
$character = $rollback->getState(); // use character from old state
|
||||
|
||||
$this->assertEquals("Gandalf the Grey", $character->name); // yes, that what we need
|
||||
$character->name = "Gandalf the White"; // make new changes
|
||||
|
||||
$this->assertAttributeEquals($character, "state", $originator); // and Originator linked to actual object again
|
||||
}
|
||||
|
||||
public function testStringState()
|
||||
{
|
||||
$originator = new Originator();
|
||||
@@ -18,52 +51,94 @@ class MementoTest extends \PHPUnit_Framework_TestCase
|
||||
$this->assertAttributeEquals("State1", "state", $originator);
|
||||
|
||||
$originator->setState("State2");
|
||||
|
||||
$this->assertAttributeEquals("State2", "state", $originator);
|
||||
|
||||
$savedState = $originator->saveToMemento();
|
||||
|
||||
$this->assertAttributeEquals("State2", "state", $savedState);
|
||||
$snapshot = $originator->getStateAsMemento();
|
||||
$this->assertAttributeEquals("State2", "state", $snapshot);
|
||||
|
||||
$originator->setState("State3");
|
||||
|
||||
$this->assertAttributeEquals("State3", "state", $originator);
|
||||
|
||||
$originator->restoreFromMemento($savedState);
|
||||
|
||||
$originator->restoreFromMemento($snapshot);
|
||||
$this->assertAttributeEquals("State2", "state", $originator);
|
||||
}
|
||||
|
||||
public function testObjectState()
|
||||
public function testSnapshotIsClone()
|
||||
{
|
||||
$originator = new Originator();
|
||||
$object = new \stdClass();
|
||||
|
||||
$originator->setState($object);
|
||||
$snapshot = $originator->getStateAsMemento();
|
||||
$object->new_property = 1;
|
||||
|
||||
$this->assertAttributeEquals($object, "state", $originator);
|
||||
$this->assertAttributeNotEquals($object, "state", $snapshot);
|
||||
|
||||
$originator->restoreFromMemento($snapshot);
|
||||
$this->assertAttributeNotEquals($object, "state", $originator);
|
||||
}
|
||||
|
||||
public function testCanChangeActualState()
|
||||
{
|
||||
$originator = new Originator();
|
||||
$first_state = new \stdClass();
|
||||
|
||||
$originator->setState($first_state);
|
||||
$snapshot = $originator->getStateAsMemento();
|
||||
$second_state = $snapshot->getState();
|
||||
|
||||
$first_state->first_property = 1; // still actual
|
||||
$second_state->second_property = 2; // just history
|
||||
$this->assertAttributeEquals($first_state, "state", $originator);
|
||||
$this->assertAttributeNotEquals($second_state, "state", $originator);
|
||||
|
||||
$originator->restoreFromMemento($snapshot);
|
||||
$first_state->first_property = 11; // now it lost state
|
||||
$second_state->second_property = 22; // must be actual
|
||||
$this->assertAttributeEquals($second_state, "state", $originator);
|
||||
$this->assertAttributeNotEquals($first_state, "state", $originator);
|
||||
}
|
||||
|
||||
public function testStateWithDifferentObjects()
|
||||
{
|
||||
$originator = new Originator();
|
||||
|
||||
$foo = new \stdClass();
|
||||
$foo->data = "foo";
|
||||
$first = new \stdClass();
|
||||
$first->data = "foo";
|
||||
|
||||
$originator->setState($foo);
|
||||
$originator->setState($first);
|
||||
$this->assertAttributeEquals($first, "state", $originator);
|
||||
|
||||
$this->assertAttributeEquals($foo, "state", $originator);
|
||||
$first_snapshot = $originator->getStateAsMemento();
|
||||
$this->assertAttributeEquals($first, "state", $first_snapshot);
|
||||
|
||||
$savedState = $originator->saveToMemento();
|
||||
$second = new \stdClass();
|
||||
$second->data = "bar";
|
||||
$originator->setState($second);
|
||||
$this->assertAttributeEquals($second, "state", $originator);
|
||||
|
||||
$this->assertAttributeEquals($foo, "state", $savedState);
|
||||
$originator->restoreFromMemento($first_snapshot);
|
||||
$this->assertAttributeEquals($first, "state", $originator);
|
||||
}
|
||||
|
||||
$bar = new \stdClass();
|
||||
$bar->data = "bar";
|
||||
public function testCaretaker()
|
||||
{
|
||||
$caretaker = new Caretaker();
|
||||
$memento1 = new Memento("foo");
|
||||
$memento2 = new Memento("bar");
|
||||
$caretaker->saveToHistory($memento1);
|
||||
$caretaker->saveToHistory($memento2);
|
||||
$this->assertAttributeEquals(array($memento1, $memento2), "history", $caretaker);
|
||||
$this->assertEquals($memento1, $caretaker->getFromHistory(0));
|
||||
$this->assertEquals($memento2, $caretaker->getFromHistory(1));
|
||||
|
||||
$originator->setState($bar);
|
||||
}
|
||||
|
||||
$this->assertAttributeEquals($bar, "state", $originator);
|
||||
|
||||
$originator->restoreFromMemento($savedState);
|
||||
|
||||
$this->assertAttributeEquals($foo, "state", $originator);
|
||||
|
||||
$foo->data = null;
|
||||
|
||||
$this->assertAttributeNotEquals($foo, "state", $savedState);
|
||||
|
||||
$this->assertAttributeNotEquals($foo, "state", $originator);
|
||||
public function testCaretakerCustomLogic()
|
||||
{
|
||||
$caretaker = new Caretaker();
|
||||
$result = $caretaker->runCustomLogic();
|
||||
$this->assertEquals("State3", $result);
|
||||
}
|
||||
}
|
||||
|
Reference in New Issue
Block a user