Governor\Framework\UnitOfWork\NestableUnitOfWork

Complexity

Total Complexity

31

Size/Duplication

Total Lines	238
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Test Coverage

Coverage

88.52%

Importance

Changes	7
Bugs	1	Features	0

19 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
B	commit()	0	29	4
A	performCleanup()	0	7	2
B	start()	0	35	4
C	rollback()	0	34	7
A	isStarted()	0	4	1
	doStart()	0	1	?
	doCommit()	0	1	?
	doRollback()	0	1	?
A	performInnerCommit()	0	20	3
A	assertStarted()	0	6	2
A	stop()	0	5	1
A	clear()	0	4	1
A	commitInnerUnitOfWork()	0	8	3
A	registerInnerUnitOfWork()	0	4	1
	saveAggregates()	0	1	?
	notifyListenersPrepareCommit()	0	1	?
	notifyListenersCleanup()	0	1	?
A	setLogger()	0	4	1

<?php

/*
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * The software is based on the Axon Framework project which is
 * licensed under the Apache 2.0 license. For more information on the Axon Framework
 * see <http://www.axonframework.org/>.
 * 
 * This software consists of voluntary contributions made by many individuals
 * and is licensed under the MIT license. For more information, see
 * <http://www.governor-framework.org/>.
 */

namespace Governor\Framework\UnitOfWork;

use Psr\Log\LoggerInterface;
use Psr\Log\LoggerAwareInterface;
use Governor\Framework\Common\Logging\NullLogger;

/**
 * Description of DummyUnitOfWork
 *
 * @author    "David Kalosi" <david.kalosi@gmail.com>
 * @license   <a href="http://www.opensource.org/licenses/mit-license.php">MIT License</a>
 */
abstract class NestableUnitOfWork implements UnitOfWorkInterface, LoggerAwareInterface
{

    /**
     * @var UnitOfWorkInterface
     */
    private $outerUnitOfWork;

    /**
     * @var NestableUnitOfWork[]
     */
    private $innerUnitsOfWork = [];

    /**
     * @var bool
     */
    private $isStarted;

    /**
     * @var LoggerInterface
     */
    protected $logger;

    function __construct()

It is generally recommended to explicitly declare the visibility for methods.

    {
        $this->logger = new NullLogger();
    }

    public function commit()
    {
        $this->logger->debug("Committing Unit Of Work");
        $this->assertStarted();
        try {
            $this->notifyListenersPrepareCommit();
            $this->saveAggregates();
            if (null === $this->outerUnitOfWork) {
                $this->logger->debug("This Unit Of Work is not nested. Finalizing commit...");
                $this->doCommit();
                $this->stop();
                $this->performCleanup();
            } else {
                $this->logger->debug("This Unit Of Work is nested. Commit will be finalized by outer Unit Of Work.");
            }
        } catch (\RuntimeException $ex) {
            $this->logger->debug("An error occurred while committing this UnitOfWork. Performing rollback...");
            $this->doRollback($ex);
            $this->stop();
            if (null === $this->outerUnitOfWork) {
                $this->performCleanup();
            }

            throw $ex;
        } finally {
            $this->logger->debug("Clearing resources of this Unit Of Work.");
            $this->clear();
        }
    }

    private function performCleanup()
    {
        foreach ($this->innerUnitsOfWork as $uow) {
            $uow->performCleanup();
        }
        $this->notifyListenersCleanup();
    }

    public function start()
    {
        $this->logger->debug("Starting Unit Of Work.");
        if ($this->isStarted) {
            throw new \RuntimeException("UnitOfWork is already started");
        }

        $this->doStart();
        if (CurrentUnitOfWork::isStarted()) {
            // we're nesting.
            $this->outerUnitOfWork = CurrentUnitOfWork::get();

            if ($this->outerUnitOfWork instanceof NestableUnitOfWork) {
                $this->outerUnitOfWork->registerInnerUnitOfWork($this);
            } else {
                $listener = new CommitOnOuterCommitTask(
                    function (UnitOfWorkInterface $uow) {

The parameter $uow is not used and could be removed.

                        $this->performInnerCommit();
                    },
                    function (UnitOfWorkInterface $uow) {

The parameter $uow is not used and could be removed.

                        $this->performCleanup();
                    },
                    function (UnitOfWorkInterface $uow, \Exception $ex = null) {
                        CurrentUnitOfWork::set($this);
                        $this->rollback($ex);
                    }
                );

                $this->outerUnitOfWork->registerListener($listener);
            }
        }
        $this->logger->debug("Registering Unit Of Work as CurrentUnitOfWork");
        CurrentUnitOfWork::set($this);
        $this->isStarted = true;
    }

    public function rollback(\Exception $ex = null)
    {
        if (null !== $ex) {
            $this->logger->debug(
                "Rollback requested for Unit Of Work due to exception. {exception} ",
                array('exception' => $ex->getMessage())
            );
        } else {
            $this->logger->debug("Rollback requested for Unit Of Work for unknown reason.");
        }

        try {
            if ($this->isStarted()) {
                foreach ($this->innerUnitsOfWork as $inner) {
                    CurrentUnitOfWork::set($inner);
                    $inner->rollback($ex);
                }
                $this->doRollback($ex);
            }
        } catch (\Exception $ex) {

Consider adding a comment why this CATCH block is empty.

        }

        if (null === $this->outerUnitOfWork) {
            $this->performCleanup();
        }

        $this->clear();
        $this->stop();

        if ($ex) {
            throw $ex;
        }
    }

    public function isStarted()
    {
        return $this->isStarted;
    }

    /**
     * Performs logic required when starting this UnitOfWork instance.
     */
    protected abstract function doStart();

The abstract declaration must precede the visibility declaration

    /**
     * Executes the logic required to commit this unit of work.
     */
    protected abstract function doCommit();

The abstract declaration must precede the visibility declaration

    /**
     * Executes the logic required to rollback this unit of work.
     *
     * @param \Exception|null $ex
     */
    protected abstract function doRollback(\Exception $ex = null);

The abstract declaration must precede the visibility declaration

    private function performInnerCommit()
    {
        $exception = null;
        $this->logger->debug("Finalizing commit of inner Unit Of Work...");
        CurrentUnitOfWork::set($this);

        try {
            $this->doCommit();
        } catch (\RuntimeException $ex) {
            $this->doRollback($ex);
            $exception = $ex;
        }

        $this->clear();
        $this->stop();

        if (null !== $exception) {
            throw $exception;
        }
    }

    private function assertStarted()
    {
        if (!$this->isStarted) {
            throw new \RuntimeException("UnitOfWork is not started");
        }
    }

    private function stop()
    {
        $this->logger->debug("Stopping Unit Of Work");
        $this->isStarted = false;
    }

    private function clear()
    {
        CurrentUnitOfWork::clear($this);
    }

    /**
     * Commit all registered inner units of work. This should be invoked after events have been dispatched and before
     * any listeners are notified of the commit.
     */
    protected function commitInnerUnitOfWork()
    {
        foreach ($this->innerUnitsOfWork as $unitOfWork) {
            if ($unitOfWork->isStarted()) {
                $unitOfWork->performInnerCommit();
            }
        }
    }

    /**
     * @param NestableUnitOfWork $unitOfWork
     */
    private function registerInnerUnitOfWork(NestableUnitOfWork $unitOfWork)
    {
        $this->innerUnitsOfWork[] = $unitOfWork;
    }

    /**
     * Saves all registered aggregates by calling their respective callbacks.
     */
    protected abstract function saveAggregates();

The abstract declaration must precede the visibility declaration

    protected abstract function notifyListenersPrepareCommit();

The abstract declaration must precede the visibility declaration

    protected abstract function notifyListenersCleanup();

The abstract declaration must precede the visibility declaration

    /**
     * @param LoggerInterface $logger
     * @return null
     */
    public function setLogger(LoggerInterface $logger)
    {
        $this->logger = $logger;
    }

}

class CommitOnOuterCommitTask extends UnitOfWorkListenerAdapter

PSR1 recommends that each class should be in its own file to aid autoloaders.

{
    /**
     * @var \Closure
     */
    private $commitClosure;

    /**
     * @var \Closure
     */
    private $cleanupClosure;

    /**
     * @var \Closure
     */
    private $rollbackClosure;

    /**
     * @param callable $commitClosure
     * @param callable $cleanupClosure
     * @param callable $rollbackClosure
     */
    function __construct(

It is generally recommended to explicitly declare the visibility for methods.

        \Closure $commitClosure,
        \Closure $cleanupClosure,
        \Closure $rollbackClosure
    ) {
        $this->commitClosure = $commitClosure;
        $this->cleanupClosure = $cleanupClosure;
        $this->rollbackClosure = $rollbackClosure;
    }

    /**
     * @param UnitOfWorkInterface $unitOfWork
     */
    public function afterCommit(UnitOfWorkInterface $unitOfWork)
    {
        $cb = $this->commitClosure;
        $cb($unitOfWork);
    }

    /**
     * @param UnitOfWorkInterface $unitOfWork
     */
    public function onCleanup(UnitOfWorkInterface $unitOfWork)
    {
        $cb = $this->cleanupClosure;
        $cb($unitOfWork);
    }

    /**
     * @param UnitOfWorkInterface $unitOfWork
     * @param \Exception $failureCause
     */
    public function onRollback(
        UnitOfWorkInterface $unitOfWork,
        \Exception $failureCause = null
    ) {
        $cb = $this->rollbackClosure;
        $cb($unitOfWork, $failureCause);
    }

}