BusUndoable::pushCommandHistory() - Code Metrics - jagarsoft/laravel-tactician - Measure and Improve Code Quality continuously with Scrutinizer

BusUndoable::pushCommandHistory() A
last analyzed 2022-02-14 23:22 UTC

↳ Parent: BusUndoable

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	1
c	1
b	0
f	0
nc	1
nop	1
dl	0
loc	3
rs	10

<?php

namespace Joselfonseca\LaravelTactician;

use Joselfonseca\LaravelTactician\Handler\MethodNameInflectorUndoable;
use Joselfonseca\LaravelTactician\Handler\CommandNameExtractorUndoable;
use Joselfonseca\LaravelTactician\Locator\LocatorInterface;
use Joselfonseca\LaravelTactician\Middleware\LockingMiddlewareUndoable;
use Joselfonseca\LaravelTactician\Handler\CommandHandlerMiddlewareUndoable;
use Joselfonseca\LaravelTactician\Exception\CommandHistoryIsEmptyException;
use Joselfonseca\LaravelTactician\Exception\CommandHistoryWasEmptiedException;
use Joselfonseca\LaravelTactician\Exception\RedoCommandHistoryIsEmptyException;

/**
 * The default Command bus Using Tactician, this is an implementation to dispatch commands to their handlers
 * trough a middleware stack, every class is resolved from the laravel's service container.
 *
 * @package Joselfonseca\LaravelTactician
 */
class BusUndoable extends Bus implements CommandBusUndoableInterface
{
    private $commandHistoryCounter = -1; // history is empty
    private $reDoCommandHistoryCounter = -1; // redo history is empty
    private $commandHistory = [];
    private $reDoCommandHistory = [];

    public function __construct(
        MethodNameInflectorUndoable $MethodNameInflector,
        CommandNameExtractorUndoable $CommandNameExtractor,
        LocatorInterface $HandlerLocator
    ) {
        parent::__construct($MethodNameInflector, $CommandNameExtractor, $HandlerLocator);

        // $this->commandHistoryCounter = $this->reDoCommandHistoryCounter = -1;
    }

    /**
     * Dispatch a command and recall it
     *
     * @param  object $command    Command to be dispatched
     * @param  array  $input      Array of input to map to the command
     * @param  array  $middleware Array of middleware class name to add to the stack, they are resolved from the laravel container
     * @return mixed
     */
    public function dispatch($command, array $input = [], array $middleware = [])
    {
        $commandDispatched = parent::dispatch($command, $input, $middleware);

        $this->pushCommandHistory( [clone $commandDispatched, $middleware] ); // Memento Pattern

        return $commandDispatched;
    }

    private function pushCommandHistory (array $commandDispatchedAndMiddleware)
    {
        $this->commandHistory[++$this->commandHistoryCounter] = $commandDispatchedAndMiddleware;
    }

    public function undo()
    {
        try{
            $commandDispatchedAndMiddleware = $this->popCommandHistory();
            $this->pushRedoCommandHistory($commandDispatchedAndMiddleware);

            $this->handleTheUndoCommand($commandDispatchedAndMiddleware[0], $commandDispatchedAndMiddleware[1]);

            return $this->topCommandHistory()[0];

        }catch (CommandHistoryWasEmptiedException $exception){}

    }

    private function popCommandHistory()
    {
        if ($this->commandHistoryCounter == -1) {
            throw new CommandHistoryIsEmptyException();
        }

        $commandDispatchedAndMiddleware = $this->commandHistory[$this->commandHistoryCounter];
        unset($this->commandHistory[$this->commandHistoryCounter]);
        --$this->commandHistoryCounter;

        return $commandDispatchedAndMiddleware;
    }

    private function topCommandHistory()
    {
        if ($this->commandHistoryCounter == -1){
            throw new CommandHistoryWasEmptiedException();
        }

        return $this->commandHistory[$this->commandHistoryCounter];
    }

    private function pushRedoCommandHistory(array $commandDispatchedAndMiddleware)
    {
        $this->reDoCommandHistory[++$this->reDoCommandHistoryCounter] = $commandDispatchedAndMiddleware;
    }

    private function handleTheUndoCommand($commandDispatched, array $middleware): void
    {
        $this->bus = new CommandBusUndoable(
            array_merge(
                [new LockingMiddlewareUndoable()],
                $this->resolveMiddleware(array_reverse($middleware)), // in reversed order
                [new CommandHandlerMiddlewareUndoable($this->CommandNameExtractor, $this->HandlerLocator, $this->MethodNameInflector)]
            )
        );
        $this->bus->handlerUndo($commandDispatched);
    }

    public function redo()
    {
        $commandDispatchedAndMiddleware = $this->popRedoCommandHistory();
        $this->pushCommandHistory($commandDispatchedAndMiddleware);

        $this->handleTheRedoCommand($commandDispatchedAndMiddleware[0], $commandDispatchedAndMiddleware[1]);

        return $commandDispatchedAndMiddleware[0];
    }

    private function popRedoCommandHistory()
    {
        if( $this->reDoCommandHistoryCounter == -1 ) {
            throw new RedoCommandHistoryIsEmptyException();
        }

        $commandDispatchedAndMiddleware = $this->reDoCommandHistory[$this->reDoCommandHistoryCounter];
        unset($this->reDoCommandHistory[$this->reDoCommandHistoryCounter]);
        --$this->reDoCommandHistoryCounter;

        return $commandDispatchedAndMiddleware;
    }

    private function handleTheRedoCommand($commandDispatched, $middleware): void
    {
        $this->bus = new CommandBusUndoable(
            array_merge(
                [new LockingMiddlewareUndoable()],
                $this->resolveMiddleware($middleware), // in original order again !!!!
                [new CommandHandlerMiddlewareUndoable($this->CommandNameExtractor, $this->HandlerLocator, $this->MethodNameInflector)]
            )
        );
        $this->bus->handlerRedo($commandDispatched);
    }

    public function clearHistory()
    {
        $this->commandHistory = [];
        $this->reDoCommandHistory = [];
        $this->commandHistoryCounter = $this->reDoCommandHistoryCounter = -1;
    }

    public function dump()
    {return;
        echo PHP_EOL.'commandHistoryCounter: '.$this->commandHistoryCounter;
function fx() {
    try {
        doSomething();
        return true;
    }
    catch (\Exception $e) {
        return false;
    }

    return false;
}
        echo PHP_EOL.'reDoCommandHistoryCounter: '.$this->reDoCommandHistoryCounter.PHP_EOL;
    }
}


1			<?php
2
3			namespace Joselfonseca\LaravelTactician;
4
5			use Joselfonseca\LaravelTactician\Handler\MethodNameInflectorUndoable;
6			use Joselfonseca\LaravelTactician\Handler\CommandNameExtractorUndoable;
7			use Joselfonseca\LaravelTactician\Locator\LocatorInterface;
8			use Joselfonseca\LaravelTactician\Middleware\LockingMiddlewareUndoable;
9			use Joselfonseca\LaravelTactician\Handler\CommandHandlerMiddlewareUndoable;
10			use Joselfonseca\LaravelTactician\Exception\CommandHistoryIsEmptyException;
11			use Joselfonseca\LaravelTactician\Exception\CommandHistoryWasEmptiedException;
12			use Joselfonseca\LaravelTactician\Exception\RedoCommandHistoryIsEmptyException;
13
14			/**
15			* The default Command bus Using Tactician, this is an implementation to dispatch commands to their handlers
16			* trough a middleware stack, every class is resolved from the laravel's service container.
17			*
18			* @package Joselfonseca\LaravelTactician
19			*/
20			class BusUndoable extends Bus implements CommandBusUndoableInterface
21			{
22			private $commandHistoryCounter = -1; // history is empty
23			private $reDoCommandHistoryCounter = -1; // redo history is empty
24			private $commandHistory = [];
25			private $reDoCommandHistory = [];
26
27			public function __construct(
28			MethodNameInflectorUndoable $MethodNameInflector,
29			CommandNameExtractorUndoable $CommandNameExtractor,
30			LocatorInterface $HandlerLocator
31			) {
32			parent::__construct($MethodNameInflector, $CommandNameExtractor, $HandlerLocator);
33
34			// $this->commandHistoryCounter = $this->reDoCommandHistoryCounter = -1;
35			}
36
37			/**
38			* Dispatch a command and recall it
39			*
40			* @param object $command Command to be dispatched
41			* @param array $input Array of input to map to the command
42			* @param array $middleware Array of middleware class name to add to the stack, they are resolved from the laravel container
43			* @return mixed
44			*/
45			public function dispatch($command, array $input = [], array $middleware = [])
46			{
47			$commandDispatched = parent::dispatch($command, $input, $middleware);
48
49			$this->pushCommandHistory( [clone $commandDispatched, $middleware] ); // Memento Pattern
50
51			return $commandDispatched;
52			}
53
54			private function pushCommandHistory (array $commandDispatchedAndMiddleware)
55			{
56			$this->commandHistory[++$this->commandHistoryCounter] = $commandDispatchedAndMiddleware;
57			}
58
59			public function undo()
60			{
61			try{
62			$commandDispatchedAndMiddleware = $this->popCommandHistory();
63			$this->pushRedoCommandHistory($commandDispatchedAndMiddleware);
64
65			$this->handleTheUndoCommand($commandDispatchedAndMiddleware[0], $commandDispatchedAndMiddleware[1]);
66
67			return $this->topCommandHistory()[0];
68
69			}catch (CommandHistoryWasEmptiedException $exception){}
			0 ignored issues – show Coding Style Comprehensibility introduced 2022-02-14 23:22 UTC by Report Bug Copy Issue Report Consider adding a comment why this CATCH block is empty. Loading history...
70			}
71
72			private function popCommandHistory()
73			{
74			if ($this->commandHistoryCounter == -1) {
75			throw new CommandHistoryIsEmptyException();
76			}
77
78			$commandDispatchedAndMiddleware = $this->commandHistory[$this->commandHistoryCounter];
79			unset($this->commandHistory[$this->commandHistoryCounter]);
80			--$this->commandHistoryCounter;
81
82			return $commandDispatchedAndMiddleware;
83			}
84
85			private function topCommandHistory()
86			{
87			if ($this->commandHistoryCounter == -1){
88			throw new CommandHistoryWasEmptiedException();
89			}
90
91			return $this->commandHistory[$this->commandHistoryCounter];
92			}
93
94			private function pushRedoCommandHistory(array $commandDispatchedAndMiddleware)
95			{
96			$this->reDoCommandHistory[++$this->reDoCommandHistoryCounter] = $commandDispatchedAndMiddleware;
97			}
98
99			private function handleTheUndoCommand($commandDispatched, array $middleware): void
100			{
101			$this->bus = new CommandBusUndoable(
102			array_merge(
103			[new LockingMiddlewareUndoable()],
104			$this->resolveMiddleware(array_reverse($middleware)), // in reversed order
105			[new CommandHandlerMiddlewareUndoable($this->CommandNameExtractor, $this->HandlerLocator, $this->MethodNameInflector)]
106			)
107			);
108			$this->bus->handlerUndo($commandDispatched);
109			}
110
111			public function redo()
112			{
113			$commandDispatchedAndMiddleware = $this->popRedoCommandHistory();
114			$this->pushCommandHistory($commandDispatchedAndMiddleware);
115
116			$this->handleTheRedoCommand($commandDispatchedAndMiddleware[0], $commandDispatchedAndMiddleware[1]);
117
118			return $commandDispatchedAndMiddleware[0];
119			}
120
121			private function popRedoCommandHistory()
122			{
123			if( $this->reDoCommandHistoryCounter == -1 ) {
124			throw new RedoCommandHistoryIsEmptyException();
125			}
126
127			$commandDispatchedAndMiddleware = $this->reDoCommandHistory[$this->reDoCommandHistoryCounter];
128			unset($this->reDoCommandHistory[$this->reDoCommandHistoryCounter]);
129			--$this->reDoCommandHistoryCounter;
130
131			return $commandDispatchedAndMiddleware;
132			}
133
134			private function handleTheRedoCommand($commandDispatched, $middleware): void
135			{
136			$this->bus = new CommandBusUndoable(
137			array_merge(
138			[new LockingMiddlewareUndoable()],
139			$this->resolveMiddleware($middleware), // in original order again !!!!
140			[new CommandHandlerMiddlewareUndoable($this->CommandNameExtractor, $this->HandlerLocator, $this->MethodNameInflector)]
141			)
142			);
143			$this->bus->handlerRedo($commandDispatched);
144			}
145
146			public function clearHistory()
147			{
148			$this->commandHistory = [];
149			$this->reDoCommandHistory = [];
150			$this->commandHistoryCounter = $this->reDoCommandHistoryCounter = -1;
151			}
152
153			public function dump()
154			{return;
155			echo PHP_EOL.'commandHistoryCounter: '.$this->commandHistoryCounter;
			0 ignored issues – show Unused Code introduced 2022-02-14 23:22 UTC by Report Bug Copy Issue Report `echo Joselfonseca\Larave...->commandHistoryCounter` is not reachable. This check looks for unreachable code. It uses sophisticated control flow analysis techniques to find statements which will never be executed. Unreachable code is most often the result of `return`, `die` or `exit` statements that have been added for debug purposes. function fx() { try { doSomething(); return true; } catch (\Exception $e) { return false; } return false; } In the above example, the last `return false` will never be executed, because a return statement has already been met in every possible execution path. Loading history...
156			echo PHP_EOL.'reDoCommandHistoryCounter: '.$this->reDoCommandHistoryCounter.PHP_EOL;
157			}
158			}
159

jagarsoft / laravel-tactician

BusUndoable::pushCommandHistory() A last analyzed 2022-02-14 23:22 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

BusUndoable::pushCommandHistory() A
last analyzed 2022-02-14 23:22 UTC