Aggregate::handleWithdrawMoney() - Code Metrics - Inspection of "Updating example code" - C4Tech/laravel-ray-emitter - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( b0a3db...81c3f8 )

by Christopher

created 2016-01-07 03:55 UTC

Aggregate::handleWithdrawMoney() A

↳ Parent: Aggregate

Complexity

Conditions	3
Paths	3

Size

Total Lines	17
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Metric	Value
dl	0
loc	17
rs	9.4286
cc	3
eloc	9
nc	3
nop	1

<?php namespace RayEmitter\Example\BankAccount;

use C4tech\RayEmitter\Domain\Aggregate as AbstractAggregate;
use Ramsey\Uuid\Uuid;

final class Aggregate extends AbstractAggregate
{
    /**
     * Minimum needed to open an account.
     * @var int|float
     */
    const MINIMUM_TO_OPEN = 50;

    /**
     * Account Was Created Event Handle
     *
     * @param  AccountWasCreated $event Event Object
     * @return void
     */
    protected function applyAccountWasCreated(AccountWasCreated $event)
    {
        $data = $event->getPayload();
        $identifier = new AccountId($event->getId());
        $this->root = new AggregateRoot($identifier);

        $this->root->owner = $data->owner;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        $this->root->balance = $data->deposit;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
    }

    /**
     * Money Deposited Event Handle
     *
     * @param  MoneyDeposited $event Event Object
     * @return void
     */
    protected function applyMoneyDeposited(MoneyDeposited $event)

    {
        $data = $event->getPayload();
        $balance = $this->root->balance->getValue();
        $balance += $data->deposit->getValue();
        $this->root->balance = new UsDollar($balance);
    }

    /**
     * Money Withdrawn Event Handle
     *
     * @param  MoneyWithdrawn $event Event Object
     * @return void
     */
    protected function applyMoneyWithdrawn(MoneyWithdrawn $event)

    {
        $data = $event->getPayload();
        $balance = $this->root->balance->getValue();
        $balance -= $data->withdrawal->getValue();
        $this->root->balance = new UsDollar($balance);
    }

    /**
     * Create Account Command Handle
     *
     * Processes business logic for the account creation command.
     * @param  CreateAccount $command Command object.
     * @return AccountWasCreated      Event object.
     */
    protected function handleCreateAccount(CreateAccount $command)
    {
        $data = $command->getPayload();

        $account_id = new AccountId(Uuid::uuid4()->toString());
        $owner = new OwnerName($data->owner);
        $initial_deposit = new UsDollar($data->deposit);

        if ($initial_deposit->getValue() < self::MINIMUM_TO_OPEN) {
            throw new MinimumDepositException($initial_deposit->getValue(), self::MINIMUM_TO_OPEN);
        }

        return new AccountWasCreated($account_id, compact('owner', 'initial_deposit'));
    }

    /**
     * Deposit Money Command Handle
     *
     * Processes business logic for the deposit money command.
     * @param  DepositMoney $command Command object.
     * @return MoneyDeposited        Event object.
     */
    protected function handleDepositMoney(DepositMoney $command)
    {
        $data = $command->getPayload();

        $account_id = new AccountId($data->account_id);
        $deposit = new UsDollar($data->deposit);

        if ($deposit->getValue() < 0) {
            throw new MinimumDepositException($deposit->getValue());
        }

        return new MoneyDeposited($account_id, compact('deposit'));
    }

    /**
     * Withdraw Money Command Handle
     *
     * Processes business logic for the withdraw money command.
     * @param  WithdrawMoney $command Command object.
     * @return MoneyWithdrawn         Event object.
     */
    protected function handleWithdrawMoney(WithdrawMoney $command)
    {
        $data = $command->getPayload();

        $account_id = new AccountId($data->account_id);
        $withdrawal = new UsDollar($data->withdrawal);

        if ($withdrawal->getValue() < 0) {
            throw new MinimumWithdrawalException($withdrawal->getValue());
        }

        if ($withdrawal->getValue() > $this->root->balance->getValue()) {
            throw new InsufficientFundsException($withdrawal->getValue(), $this->balance->getValue());
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        }

        return new MoneyWithdrawn($account_id, compact('withdrawal'));
    }
}


1		<?php namespace RayEmitter\Example\BankAccount;
2
3		use C4tech\RayEmitter\Domain\Aggregate as AbstractAggregate;
4		use Ramsey\Uuid\Uuid;
5
6		final class Aggregate extends AbstractAggregate
7		{
8		/**
9		* Minimum needed to open an account.
10		* @var int\|float
11		*/
12		const MINIMUM_TO_OPEN = 50;
13
14		/**
15		* Account Was Created Event Handle
16		*
17		* @param AccountWasCreated $event Event Object
18		* @return void
19		*/
20		protected function applyAccountWasCreated(AccountWasCreated $event)
21		{
22		$data = $event->getPayload();
23		$identifier = new AccountId($event->getId());
24		$this->root = new AggregateRoot($identifier);
		0 ignored issues – show Documentation Bug introduced 2016-01-07 03:58 UTC by Report Bug Copy Issue Report It seems like `new \RayEmitter\Example\...regateRoot($identifier)` of type `object<RayEmitter\Exampl...kAccount\AggregateRoot>` is incompatible with the declared type `object<C4tech\RayEmitter...AggregateRootInterface>` of property `$root`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
25		$this->root->owner = $data->owner;
		0 ignored issues – show Documentation introduced 2016-01-07 03:58 UTC by Report Bug Copy Issue Report The property `$owner` is declared protected in `RayEmitter\Example\BankAccount\Entity`. Since you implemented `__set()`, maybe consider adding a @property or @property-write annotation. This makes it easier for IDEs to provide auto-completion. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
26		$this->root->balance = $data->deposit;
		0 ignored issues – show Documentation introduced 2016-01-07 03:58 UTC by Report Bug Copy Issue Report The property `$balance` is declared protected in `RayEmitter\Example\BankAccount\Entity`. Since you implemented `__set()`, maybe consider adding a @property or @property-write annotation. This makes it easier for IDEs to provide auto-completion. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
27		}
28
29		/**
30		* Money Deposited Event Handle
31		*
32		* @param MoneyDeposited $event Event Object
33		* @return void
34		*/
35	View Code Duplication	protected function applyMoneyDeposited(MoneyDeposited $event)
		0 ignored issues – show Duplication introduced 2016-01-06 20:29 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
36		{
37		$data = $event->getPayload();
38		$balance = $this->root->balance->getValue();
39		$balance += $data->deposit->getValue();
40		$this->root->balance = new UsDollar($balance);
41		}
42
43		/**
44		* Money Withdrawn Event Handle
45		*
46		* @param MoneyWithdrawn $event Event Object
47		* @return void
48		*/
49	View Code Duplication	protected function applyMoneyWithdrawn(MoneyWithdrawn $event)
		0 ignored issues – show Duplication introduced 2016-01-06 20:29 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
50		{
51		$data = $event->getPayload();
52		$balance = $this->root->balance->getValue();
53		$balance -= $data->withdrawal->getValue();
54		$this->root->balance = new UsDollar($balance);
55		}
56
57		/**
58		* Create Account Command Handle
59		*
60		* Processes business logic for the account creation command.
61		* @param CreateAccount $command Command object.
62		* @return AccountWasCreated Event object.
63		*/
64		protected function handleCreateAccount(CreateAccount $command)
65		{
66		$data = $command->getPayload();
67
68		$account_id = new AccountId(Uuid::uuid4()->toString());
69		$owner = new OwnerName($data->owner);
70		$initial_deposit = new UsDollar($data->deposit);
71
72		if ($initial_deposit->getValue() < self::MINIMUM_TO_OPEN) {
73		throw new MinimumDepositException($initial_deposit->getValue(), self::MINIMUM_TO_OPEN);
74		}
75
76		return new AccountWasCreated($account_id, compact('owner', 'initial_deposit'));
77		}
78
79		/**
80		* Deposit Money Command Handle
81		*
82		* Processes business logic for the deposit money command.
83		* @param DepositMoney $command Command object.
84		* @return MoneyDeposited Event object.
85		*/
86		protected function handleDepositMoney(DepositMoney $command)
87		{
88		$data = $command->getPayload();
89
90		$account_id = new AccountId($data->account_id);
91		$deposit = new UsDollar($data->deposit);
92
93		if ($deposit->getValue() < 0) {
94		throw new MinimumDepositException($deposit->getValue());
95		}
96
97		return new MoneyDeposited($account_id, compact('deposit'));
98		}
99
100		/**
101		* Withdraw Money Command Handle
102		*
103		* Processes business logic for the withdraw money command.
104		* @param WithdrawMoney $command Command object.
105		* @return MoneyWithdrawn Event object.
106		*/
107		protected function handleWithdrawMoney(WithdrawMoney $command)
108		{
109		$data = $command->getPayload();
110
111		$account_id = new AccountId($data->account_id);
112		$withdrawal = new UsDollar($data->withdrawal);
113
114		if ($withdrawal->getValue() < 0) {
115		throw new MinimumWithdrawalException($withdrawal->getValue());
116		}
117
118		if ($withdrawal->getValue() > $this->root->balance->getValue()) {
119		throw new InsufficientFundsException($withdrawal->getValue(), $this->balance->getValue());
		0 ignored issues – show Documentation introduced 2016-01-07 03:58 UTC by Report Bug Copy Issue Report The property `balance` does not exist on `object<RayEmitter\Example\BankAccount\Aggregate>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
120		}
121
122		return new MoneyWithdrawn($account_id, compact('withdrawal'));
123		}
124		}
125

C4Tech / laravel-ray-emitter

Push — master ( b0a3db...81c3f8 )

Aggregate::handleWithdrawMoney() A

Complexity

Size

Duplication

Duplication Side-by-Side

Filter issues like