Added persistUrlParams config option

.travis.yml

@@ -9,7 +9,7 @@ php:
 
 env:
 #  - CAKE_VERSION=2.8.0 DB=mysql
-  - CAKE_VERSION=2.9.2 DB=mysql
+  - CAKE_VERSION=2.9.9 DB=mysql
 
 install:
   - git clone git://github.com/cakephp/cakephp ../cakephp && cd ../cakephp && git checkout $CAKE_VERSION

Controller/Component/WizardComponent.php

@@ -121,6 +121,14 @@ class WizardComponent extends Component {
  */
 	public $draftUrl = '/';
 
+/**
+ * If `true` then URL parameters from the first step will be present in the URLs
+ * of all other steps.
+ *
+ * @var bool
+ */
+	public $persistUrlParams = false;
+
 /**
  * If true, the first "non-skipped" branch in a group will be used if a branch has
  * not been included specifically.
@@ -205,6 +213,13 @@ class WizardComponent extends Component {
  */
 	protected $_wizardUrl = array();
 
+/**
+ * Holds the array with steps and branches from the initial Wizard configuration.
+ *
+ * @var array
+ */
+	protected $_stepsAndBranches = array();
+
 /**
  * Initializes WizardComponent for use in the controller
  *
@@ -216,6 +231,7 @@ class WizardComponent extends Component {
 	public function initialize(Controller $controller) {
 		$this->controller = $controller;
 		$this->__setSessionKeys();
+		$this->_stepsAndBranches = $this->steps;
 	}
 
 /**
@@ -244,16 +260,27 @@ private function __setSessionKeys() {
  */
 	public function startup(Controller $controller) {
 		$this->__setSessionKeys();
-		$this->steps = $this->_parseSteps($this->steps);
 		$this->config('action', $this->action);
-		$this->config('steps', $this->steps);
+		$this->_configSteps($this->steps);
 		if (!in_array('Wizard.Wizard', $this->controller->helpers) && !array_key_exists('Wizard.Wizard', $this->controller->helpers)) {
 			$this->controller->helpers['Wizard.Wizard'] = array(
 				'sessionRootKey' => $this->sessionRootKey,
 			);
 		}
 	}
 
+/**
+ * Parses the steps array by stripping off nested arrays not included in the branches
+ * and writes a simple array with the correct steps to session.
+ *
+ * @param array $steps Array to be parsed for nested arrays.
+ * @return void
+ */
+	protected function _configSteps($steps) {
+		$this->steps = $this->_parseSteps($steps);
+		$this->config('steps', $this->steps);
+	}
+
 /**
  * Parses the steps array by stripping off nested arrays not included in the branches
  * and returns a simple array with the correct steps.
@@ -513,6 +540,9 @@ protected function _validStep($step) {
  * @return void
  */
 	protected function _setCurrentStep($step) {
+		if (!in_array($step, $this->steps)) {
+			return;
+		}
 		$this->_currentStep = reset($this->steps);
 		while (current($this->steps) != $step) {
 			$this->_currentStep = next($this->steps);
@@ -559,6 +589,8 @@ public function save($step = null, $data = null) {
 			$data = $this->controller->request->data;
 		}
 		$this->controller->Session->write("$this->_sessionKey.$step", $data);
+		$this->_getExpectedStep();
+		$this->_setCurrentStep($step);
 	}
 
 /**
@@ -576,11 +608,17 @@ public function redirect($step = null, $status = null, $exit = true) {
 		if ($step == null) {
 			$step = $this->_getExpectedStep();
 		}
-		$url = array(
-			'controller' => Inflector::underscore($this->controller->name),
-			'action' => $this->action,
-			$step
-		);
+		if ($this->persistUrlParams) {
+			$url = Router::reverseToArray($this->controller->request);
+			$url['action'] = $this->action;
+			$url[0] = $step;
+		} else {
+			$url = array(
+				'controller' => Inflector::underscore($this->controller->name),
+				'action' => $this->action,
+				$step,
+			);
+		}
 		return $this->controller->redirect($url, $status, $exit);
 	}
 
@@ -606,6 +644,7 @@ public function branch($name, $skip = false) {
 		}
 		$branches[$name] = $value;
 		$this->controller->Session->write($this->_branchKey, $branches);
+		$this->_configSteps($this->_stepsAndBranches);
 	}
 
 /**
@@ -677,6 +716,7 @@ public function delete($key = null) {
  */
 	public function unbranch($branch) {
 		$this->controller->Session->delete("$this->_branchKey.$branch");
+		$this->_configSteps($this->_stepsAndBranches);
 	}
 
 }

Test/Case/Controller/Component/WizardComponentTest.php

@@ -23,6 +23,7 @@ class WizardUserMock extends Model {
 /**
  * AuthTestController class
  *
+ * @property WizardComponent $Wizard
  * @package       Wizard.Test.Case.Controller.Component
  */
 class WizardTestController extends Controller {
@@ -71,6 +72,22 @@ public function processStep2() {
 		return false;
 	}
 
+	public function processGender() {
+		if (!empty($this->request->data)) {
+			if ($this->Wizard->defaultBranch === false) {
+				if ($this->request->data['WizardUserMock']['gender'] == 'female') {
+					$this->Wizard->unbranch('male');
+					$this->Wizard->branch('female');
+				} else {
+					$this->Wizard->unbranch('female');
+					$this->Wizard->branch('male');
+				}
+			}
+			return true;
+		}
+		return false;
+	}
+
 	public function processStep3() {
 		if (!empty($this->request->data)) {
 			return true;
@@ -136,7 +153,7 @@ public function setUp() {
  */
 	public function tearDown() {
 		parent::tearDown();
-		$this->Wizard->Session->delete('Wizard');
+		CakeSession::destroy();
 		unset($this->Controller, $this->Wizard);
 	}
 
@@ -374,6 +391,87 @@ public function testProcessStepOnePost() {
 		$this->assertEquals($expectedSession, $resultSession);
 	}
 
+/**
+ * Tests 'autoAdvance' and 'defaultBranch' settings set to false and manual call to `branch()`.
+ *
+ * @return void
+ */
+	public function testProcessGenderPost() {
+		$this->Wizard->Session->delete('Wizard');
+		unset($this->Controller, $this->Wizard);
+		$CakeRequest = new CakeRequest(null, false);
+		$CakeResponse = $this->getMock('CakeResponse', array('send'));
+		$this->Controller = new WizardTestController($CakeRequest, $CakeResponse);
+		$this->Controller->components['Wizard.Wizard']['autoAdvance'] = false;
+		$this->Controller->components['Wizard.Wizard']['defaultBranch'] = false;
+		$ComponentCollection = new ComponentCollection();
+		$ComponentCollection->init($this->Controller);
+		$this->Controller->Components->init($this->Controller);
+		$this->Wizard = $this->Controller->Wizard;
+		$this->Wizard->initialize($this->Controller);
+
+		// Set session prerequisites.
+		$session = array(
+			'config' => array(
+				'steps' => array(
+					'step1',
+					'step2',
+					'gender',
+					'confirmation',
+				),
+				'action' => 'wizard',
+				'expectedStep' => 'gender',
+				'activeStep' => 'gender',
+			),
+			'WizardTest' => array(
+				'step1' => array(),
+				'step2' => array(),
+			),
+		);
+		$this->Wizard->Session->write('Wizard', $session);
+
+		$this->Wizard->startup($this->Controller);
+		$postData = array(
+			'WizardUserMock' => array(
+				'gender' => 'female',
+			),
+		);
+		$this->Wizard->controller->request->data = $postData;
+		$CakeResponse = $this->Wizard->process('gender');
+
+		$expectedSession = array(
+			'branches' => array(
+				'WizardTest' => array(
+					'female' => 'branch',
+				),
+			),
+			'config' => array(
+				'steps' => array(
+					'step1',
+					'step2',
+					'gender',
+					'step4',
+					'step5',
+					'confirmation',
+				),
+				'action' => 'wizard',
+				'expectedStep' => 'step4',
+				'activeStep' => 'gender',
+			),
+			'WizardTest' => array(
+				'step1' => array(),
+				'step2' => array(),
+				'gender' => $postData,
+			),
+		);
+		$resultSession = $this->Wizard->Session->read('Wizard');
+		$this->assertEquals($expectedSession, $resultSession);
+
+		$this->assertInstanceOf('CakeResponse', $CakeResponse);
+		$headers = $CakeResponse->header();
+		$this->assertContains('/wizard/step4', $headers['Location']);
+	}
+
 	public function testProcessAutovalidatePost() {
 		// Set session prerequisites.
 		$session = array(
@@ -553,4 +651,60 @@ public function testProcessAfterComplete() {
 		$resultSession = $this->Wizard->Session->read('Wizard');
 		$this->assertEquals($expectedSession, $resultSession);
 	}
+
+	public function testRedirectPersistUrlParams() {
+		$session = $this->Wizard->Session->read('Wizard');
+		$this->assertEmpty($session);
+
+		$url = '/wizard_test/wizard/step1/123/key:value?x=7&y=9';
+		$CakeRequest = new CakeRequest($url, true);
+		$CakeRequest->addParams(Router::parse($url));
+		$CakeResponse = $this->getMock('CakeResponse', array('send'));
+		$this->Controller = new WizardTestController($CakeRequest, $CakeResponse);
+		$this->Controller->components['Wizard.Wizard']['persistUrlParams'] = true;
+		$ComponentCollection = new ComponentCollection();
+		$ComponentCollection->init($this->Controller);
+		$this->Controller->Components->init($this->Controller);
+		$this->Wizard = $this->Controller->Wizard;
+		$this->Wizard->initialize($this->Controller);
+
+		$this->Wizard->startup($this->Controller);
+		//$this->Wizard->persistUrlParams = true;
+		// Emulate GET request to set session variables.
+		$this->Wizard->process('step1');
+		// Emulate POST request.
+		$postData = array(
+			'User' => array(
+				'username' => 'admin',
+				'password' => 'pass',
+			),
+		);
+		$this->Wizard->controller->request->data = $postData;
+		$CakeResponse = $this->Wizard->process('step1');
+
+		$this->assertInstanceOf('CakeResponse', $CakeResponse);
+		$headers = $CakeResponse->header();
+		$this->assertContains('/wizard_test/wizard/step2/123/key:value?x=7&y=9', $headers['Location']);
+
+		$expectedSession = array(
+			'config' => array(
+				'steps' => array(
+					'step1',
+					'step2',
+					'gender',
+					'step3',
+					'step4',
+					'confirmation',
+				),
+				'action' => 'wizard',
+				'expectedStep' => 'step2',
+				'activeStep' => 'step1',
+			),
+			'WizardTest' => array(
+				'step1' => $postData,
+			),
+		);
+		$resultSession = $this->Wizard->Session->read('Wizard');
+		$this->assertEquals($expectedSession, $resultSession);
+	}
 }

Test/Case/View/Helper/WizardHelperTest.php

@@ -156,4 +156,39 @@ public function testProgressMenuCustomTitles() {
 		$result = $this->Wizard->progressMenu($titles);
 		$this->assertEquals($expected, $result);
 	}
+
+	public function testProgressMenuPersistUrlParams() {
+		$url = '/wizard_test/wizard/gender/123?x=7&y=9';
+		$CakeRequest = new CakeRequest($url, true);
+		$CakeRequest->addParams(Router::parse($url));
+		$Controller = new Controller($CakeRequest, new CakeResponse());
+		$View = new View($Controller);
+		$this->Wizard = new WizardHelper($View);
+		$session = array(
+			'config' => array(
+				'steps' => array(
+					'step1',
+					'step2',
+					'gender',
+					'step3',
+					'step4',
+					'confirmation',
+				),
+				'action' => 'wizard',
+				'expectedStep' => 'gender',
+				'activeStep' => 'gender',
+				'persistUrlParams' => true,
+			),
+		);
+		CakeSession::write('Wizard', $session);
+
+		$expected = '<div class="complete"><a href="/wizard_test/wizard/step1/123?x=7&amp;y=9">Step1</a></div>';
+		$expected .= '<div class="complete"><a href="/wizard_test/wizard/step2/123?x=7&amp;y=9">Step2</a></div>';
+		$expected .= '<div class="expected active"><a href="/wizard_test/wizard/gender/123?x=7&amp;y=9">Gender</a></div>';
+		$expected .= '<div class="incomplete"><a href="#">Step3</a></div>';
+		$expected .= '<div class="incomplete"><a href="#">Step4</a></div>';
+		$expected .= '<div class="incomplete"><a href="#">Confirmation</a></div>';
+		$result = $this->Wizard->progressMenu();
+		$this->assertEquals($expected, $result);
+	}
 }