Improve redirect to step

README.md

@@ -311,6 +311,18 @@ $name = $secondStep->find('first')->data('name');
 // 'Lucas'
 ```
 
+### Redirect to the step
+
+If you want to manually redirect to another step, you can use the `redirectToStep()` of the wizard, it will return a redirect response.
+
+```php
+// given a step slug
+return $wizard->redirectToStep('second');
+
+// given a step insatnce
+return $wizard->redirectToStep($secondStep);
+```
+
 ### Step repository
 
 Step repository saves all steps data, if you want to use another step, you need to use it:

src/Step.php

@@ -390,16 +390,6 @@ public function nextSlug()
      */
     public function cacheProgress(Request $request, array $additionalData = [])
     {
-        // Get cache data, and push this step data.
-        $cacheData = $this->wizard->cache()->get();
-        $cacheData[$this->slug] = $this->getRequestData($request);
-        $cacheData = array_merge($cacheData, $additionalData);
-
-        $nextStepIndex = $this->wizard->nextStepIndex();
-
-        // Save data to cache.
-        $this->wizard->cacheStepData($cacheData, $nextStepIndex);
-
-        return $this->wizard->cache()->get();
+        return $this->wizard->cacheProgress($request, $this, $additionalData);
     }
 }

src/Wizard.php

@@ -4,6 +4,7 @@
 
 use Closure;
 use Illuminate\Foundation\Application;
+use Illuminate\Http\Request;
 use Illuminate\Support\Arr;
 use RuntimeException;
 use Ycs77\LaravelWizard\Cache\CacheManager;
@@ -117,6 +118,59 @@ public function nextStepIndex()
         return $nextStepIndex;
     }
 
+    /**
+     * Cache progress data.
+     *
+     * @param  \Illuminate\Http\Request  $request
+     * @param  \Ycs77\LaravelWizard\Step  $step
+     * @param  array  $additionalData
+     * @return array
+     */
+    public function cacheProgress(Request $request, Step $step, array $additionalData = [])
+    {
+        if (! $this->option('cache')) {
+            return;
+        }
+
+        // Get cache data, and push this step data.
+        $cacheData = $this->cache->get();
+        $cacheData[$step->slug()] = $step->getRequestData($request);
+        $cacheData = array_merge($cacheData, $additionalData);
+
+        $nextStepIndex = $this->nextStepIndex();
+
+        // Save data to cache.
+        $this->cacheStepData($cacheData, $nextStepIndex);
+
+        return $this->cache->get();
+    }
+
+    /**
+     * Set the last processed step index.
+     *
+     * @return self
+     */
+    public function setLastProcessedIndex($stepIndex)
+    {
+        if (! $this->option('cache')) {
+            return;
+        }
+
+        $this->cacheStepData($this->cache->get(), $stepIndex);
+
+        return $this;
+    }
+
+    /**
+     * Get the last processed step index.
+     *
+     * @return int|null
+     */
+    public function getLastProcessedIndex()
+    {
+        return $this->cache->getLastProcessedIndex();
+    }
+
     /**
      * Get the action URL.
      *
@@ -136,16 +190,23 @@ public function getActionUrl(string $method, $parameters = [])
     /**
      * Redirect to the given step.
      *
-     * @param  string|null  $stepSlug
+     * @param  string|\Ycs77\LaravelWizard\Step|null  $step
+     * @param  bool  $setLastIndex
      * @return \Illuminate\Http\RedirectResponse
      */
-    public function redirectToStep(string $stepSlug = null)
+    public function redirectToStep($step = null, $setLastIndex = true)
     {
-        if (is_null($stepSlug)) {
-            $stepSlug = $this->nextSlug();
+        if (is_null($step)) {
+            $step = $this->stepRepo()->next();
+        } elseif (is_string($step)) {
+            $step = $this->stepRepo()->find($step);
+        }
+
+        if ($this->option('cache') && $setLastIndex) {
+            $this->setLastProcessedIndex($step->index());
         }
 
-        return redirect($this->getActionUrl('create', [$stepSlug]));
+        return redirect($this->getActionUrl('create', [$step->slug()]));
     }
 
     /**

src/Wizardable.php

@@ -103,17 +103,13 @@ public function store(Request $request, string $step)
 
         // If trigger from 'back', set this step index and redirect to prev step.
         if ($request->query('_trigger') === 'back' && $this->beforeBackWizardStep($request, $step)) {
-            if ($this->wizard()->option('cache')) {
-                $step->cacheProgress($request);
-            }
+            $this->wizard()->cacheProgress($request, $step);
 
             $prevStep = $this->wizard()->stepRepo()->prev();
 
-            return $this->setThisStepAndRedirectTo($request, $prevStep);
+            return $this->redirectToStep($prevStep);
         } elseif ($step->skip() && $request->query('_trigger') === 'skip') {
-            if ($this->wizard()->option('cache')) {
-                $step->cacheProgress($request);
-            }
+            $this->wizard()->cacheProgress($request, $step);
         } else {
             // Form validation.
             if ($this->canValidate($request)) {
@@ -128,7 +124,7 @@ public function store(Request $request, string $step)
             }
 
             if ($this->wizard()->option('cache')) {
-                $step->cacheProgress($request);
+                $this->wizard()->cacheProgress($request, $step);
             } else {
                 $step->saveData($request, $step->getRequestData($request), $step->getModel());
             }
@@ -153,7 +149,7 @@ public function store(Request $request, string $step)
             return $this->redirectToDone($data);
         }
 
-        return $this->redirectToStep();
+        return $this->redirectToStep(null, false);
     }
 
     /**
@@ -181,25 +177,6 @@ protected function renderDoneView(Request $request)
         ]);
     }
 
-    /**
-     * Set this step and redirect to this step.
-     *
-     * @param  \Illuminate\Http\Request  $request
-     * @param  \Ycs77\LaravelWizard\Step  $step
-     * @return \Illuminate\Http\RedirectResponse
-     */
-    protected function setThisStepAndRedirectTo(Request $request, Step $step)
-    {
-        if ($this->wizard()->option('cache')) {
-            $this->wizard()->cacheStepData(
-                $this->wizard()->cache()->get(),
-                $step->index()
-            );
-        }
-
-        return $this->redirectToStep($step->slug());
-    }
-
     /**
      * Redirect to last processed step.
      *
@@ -211,7 +188,7 @@ protected function redirectToLastProcessedStep(Request $request, int $lastProces
     {
         $lastProcessedStep = $this->wizard()->stepRepo()->get($lastProcessedIndex);
 
-        return $this->redirectToStep($lastProcessedStep->slug());
+        return $this->redirectToStep($lastProcessedStep->slug(), false);
     }
 
     /**
@@ -228,25 +205,27 @@ protected function canValidate(Request $request)
     /**
      * Redirect to the step.
      *
-     * @param  string|null  $stepSlug
+     * @param  string|\Ycs77\LaravelWizard\Step|null  $step
+     * @param  bool  $setLastIndex
      * @return \Illuminate\Http\RedirectResponse
      */
-    protected function redirectToStep(string $stepSlug = null)
+    protected function redirectToStep($step = null, $setLastIndex = true)
     {
-        return $this->wizard()->redirectToStep($stepSlug);
+        return $this->wizard()->redirectToStep($step, $setLastIndex);
     }
 
     /**
      * Redirect to the step.
      *
      * Alias of `redirectToStep()`.
      *
-     * @param  string|null  $stepSlug
+     * @param  string|\Ycs77\LaravelWizard\Step|null  $step
+     * @param  bool  $setLastIndex
      * @return \Illuminate\Http\RedirectResponse
      */
-    protected function redirectTo(string $stepSlug = null)
+    protected function redirectTo($step = null, $setLastIndex = true)
     {
-        return $this->redirectToStep($stepSlug);
+        return $this->redirectToStep($step, $setLastIndex);
     }
 
     /**
@@ -313,7 +292,7 @@ public function getActionUrl(string $method, $parameters = [])
     protected function getLastProcessedStepIndex(string $stepSlug = null)
     {
         if ($this->wizard()->option('cache')) {
-            return $this->wizard()->cache()->getLastProcessedIndex() ?? 0;
+            return $this->wizard()->getLastProcessedIndex() ?? 0;
         } elseif (is_string($stepSlug)) {
             return $this->wizard()->stepRepo()->findKey($stepSlug, 0);
         }

tests/Unit/StepTest.php

@@ -3,8 +3,7 @@
 namespace Ycs77\LaravelWizard\Test\Unit;
 
 use Illuminate\Foundation\Testing\RefreshDatabase;
-use Illuminate\Http\Request;
-use Ycs77\LaravelWizard\Test\Stubs\PostStepStub;
+use Ycs77\LaravelWizard\Contracts\CacheStore;
 use Ycs77\LaravelWizard\Test\Stubs\StepStub;
 use Ycs77\LaravelWizard\Test\Stubs\UserStepStub;
 use Ycs77\LaravelWizard\Test\TestCase;
@@ -93,93 +92,4 @@ public function testGetDataKey()
         $this->assertEquals('user-step-stub', $this->step->getDataKey());
         $this->assertEquals('user-step-stub.field', $this->step->getDataKey('field'));
     }
-
-    public function testCacheProgress()
-    {
-        // arrange
-        $expected = [
-            'user-step-stub' => [
-                'name' => 'Lucas Yang',
-            ],
-            '_last_index' => 1,
-        ];
-        $request = Request::create('http://example.com');
-
-        $this->step->shouldReceive('getRequestData')
-            ->once()
-            ->andReturn(['name' => 'Lucas Yang']);
-
-        /** @param \Mockery\MockInterface $mock */
-        $cache = $this->mock(CacheStore::class, function ($mock) use ($expected) {
-            $mock->shouldReceive('get')
-                ->twice()
-                ->andReturn([], $expected);
-        });
-        $this->wizard->shouldReceive('cache')->twice()->andReturn($cache);
-        $this->wizard->shouldReceive('nextStepIndex')->once()->andReturn(1);
-        $this->wizard->shouldReceive('cacheStepData')
-            ->once()
-            ->with([
-                'user-step-stub' => [
-                    'name' => 'Lucas Yang',
-                ],
-            ], 1);
-
-        // act
-        $actual = $this->step->cacheProgress($request);
-
-        // assert
-        $this->assertEquals($expected, $actual);
-    }
-
-    public function testSecondStepCacheProgress()
-    {
-        // arrange
-        $expected = [
-            'user-step-stub' => [
-                'name' => 'Lucas Yang',
-            ],
-            'post-step-stub' => [
-                'phone' => '12345678',
-            ],
-            '_last_index' => 1,
-        ];
-        $request = Request::create('http://example.com');
-
-        $this->step = $this->mock(PostStepStub::class, [$this->wizard, 1])->makePartial();
-        $this->step->shouldReceive('getRequestData')
-            ->once()
-            ->andReturn(['phone' => '12345678']);
-
-        /** @param \Mockery\MockInterface $mock */
-        $cache = $this->mock(CacheStore::class, function ($mock) use ($expected) {
-            $mock->shouldReceive('get')
-                ->twice()
-                ->andReturn([
-                    'user-step-stub' => [
-                        'name' => 'Lucas Yang',
-                    ],
-                    '_last_index' => 1,
-                ], $expected);
-        });
-        $this->wizard->shouldReceive('cache')->twice()->andReturn($cache);
-        $this->wizard->shouldReceive('nextStepIndex')->once()->andReturn(null);
-        $this->wizard->shouldReceive('cacheStepData')
-            ->once()
-            ->with([
-                'user-step-stub' => [
-                    'name' => 'Lucas Yang',
-                ],
-                'post-step-stub' => [
-                    'phone' => '12345678',
-                ],
-                '_last_index' => 1,
-            ], null);
-
-        // act
-        $actual = $this->step->cacheProgress($request);
-
-        // assert
-        $this->assertEquals($expected, $actual);
-    }
 }