AddDonationUseCase::newDonationFromRequest() - Code Metrics - Inspection of "Moved files to reflect contexts" - wmde/FundraisingFrontend - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#594)

by Jeroen De

created 2016-07-31 06:06 UTC

AddDonationUseCase::newDonationFromRequest() A

↳ Parent: AddDonationUseCase

Complexity

Conditions	1
Paths	1

Size

Total Lines	10
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

declare( strict_types = 1 );

namespace WMDE\Fundraising\Frontend\DonatingContext\UseCases\AddDonation;

use WMDE\Fundraising\Frontend\Domain\Model\PersonName;
use WMDE\Fundraising\Frontend\Domain\Model\PhysicalAddress;
use WMDE\Fundraising\Frontend\DonatingContext\Authorization\DonationTokenFetcher;
use WMDE\Fundraising\Frontend\DonatingContext\Domain\Model\Donation;
use WMDE\Fundraising\Frontend\DonatingContext\Domain\Model\DonationPayment;
use WMDE\Fundraising\Frontend\DonatingContext\Domain\Model\DonationTrackingInfo;
use WMDE\Fundraising\Frontend\DonatingContext\Domain\Model\Donor;
use WMDE\Fundraising\Frontend\DonatingContext\Domain\Repositories\DonationRepository;
use WMDE\Fundraising\Frontend\DonatingContext\Infrastructure\DonationConfirmationMailer;
use WMDE\Fundraising\Frontend\PaymentContext\Domain\Model\BankTransferPayment;
use WMDE\Fundraising\Frontend\PaymentContext\Domain\Model\DirectDebitPayment;
use WMDE\Fundraising\Frontend\PaymentContext\Domain\Model\PaymentMethod;
use WMDE\Fundraising\Frontend\PaymentContext\Domain\Model\PaymentType;
use WMDE\Fundraising\Frontend\PaymentContext\Domain\Model\PaymentWithoutAssociatedData;
use WMDE\Fundraising\Frontend\PaymentContext\Domain\Model\PayPalData;
use WMDE\Fundraising\Frontend\PaymentContext\Domain\Model\PayPalPayment;
use WMDE\Fundraising\Frontend\PaymentContext\Domain\TransferCodeGenerator;

/**
 * @license GNU GPL v2+
 * @author Kai Nissen < [email protected] >
 * @author Jeroen De Dauw < [email protected] >
 */
class AddDonationUseCase {

	private $donationRepository;
	private $donationValidator;
	private $policyValidator;
	private $referrerGeneralizer;
	private $mailer;
	private $transferCodeGenerator;
	private $tokenFetcher;

	public function __construct( DonationRepository $donationRepository, AddDonationValidator $donationValidator,
								 AddDonationPolicyValidator $policyValidator, ReferrerGeneralizer $referrerGeneralizer,
								 DonationConfirmationMailer $mailer, TransferCodeGenerator $transferCodeGenerator,
								 DonationTokenFetcher $tokenFetcher ) {
		$this->donationRepository = $donationRepository;
		$this->donationValidator = $donationValidator;
		$this->policyValidator = $policyValidator;
		$this->referrerGeneralizer = $referrerGeneralizer;
		$this->mailer = $mailer;
		$this->transferCodeGenerator = $transferCodeGenerator;

		$this->tokenFetcher = $tokenFetcher;
	}

	public function addDonation( AddDonationRequest $donationRequest ): AddDonationResponse {
		$validationResult = $this->donationValidator->validate( $donationRequest );

		if ( $validationResult->hasViolations() ) {
			return AddDonationResponse::newFailureResponse( $validationResult->getViolations() );
		}

		$donation = $this->newDonationFromRequest( $donationRequest );

		if ( $this->policyValidator->needsModeration( $donationRequest ) ) {
			$donation->markForModeration();
		}

		// TODO: handle exceptions
		$this->donationRepository->storeDonation( $donation );

		// TODO: handle exceptions
		$tokens = $this->tokenFetcher->getTokens( $donation->getId() );

		$this->sendDonationConfirmationEmail( $donation );

		return AddDonationResponse::newSuccessResponse(
			$donation,
			$tokens->getUpdateToken(),
			$tokens->getAccessToken()
		);
	}

	private function newDonationFromRequest( AddDonationRequest $donationRequest ): Donation {
		return new Donation(
			null,
			$this->getInitialDonationStatus( $donationRequest->getPaymentType() ),
			$this->getPersonalInfoFromRequest( $donationRequest ),
			$this->getPaymentFromRequest( $donationRequest ),
			$donationRequest->getOptIn() === '1',
			$this->newTrackingInfoFromRequest( $donationRequest )
		);
	}

	private function getPersonalInfoFromRequest( AddDonationRequest $request ) {
		if ( $request->donorIsAnonymous() ) {
			return null;
		}
		return new Donor(
			$this->getNameFromRequest( $request ),
			$this->getPhysicalAddressFromRequest( $request ),
			$request->getDonorEmailAddress()
		);
	}

	private function getPhysicalAddressFromRequest( AddDonationRequest $request ): PhysicalAddress {
		$address = new PhysicalAddress();

		$address->setStreetAddress( $request->getDonorStreetAddress() );
		$address->setPostalCode( $request->getDonorPostalCode() );
		$address->setCity( $request->getDonorCity() );
		$address->setCountryCode( $request->getDonorCountryCode() );

		return $address->freeze()->assertNoNullFields();
	}

	private function getNameFromRequest( AddDonationRequest $request ): PersonName {
		$name = $request->donorIsCompany() ? PersonName::newCompanyName() : PersonName::newPrivatePersonName();

		$name->setSalutation( $request->getDonorSalutation() );
		$name->setTitle( $request->getDonorTitle() );
		$name->setCompanyName( $request->getDonorCompany() );
		$name->setFirstName( $request->getDonorFirstName() );
		$name->setLastName( $request->getDonorLastName() );

		return $name->freeze()->assertNoNullFields();
	}

	private function getInitialDonationStatus( string $paymentType ): string {
		if ( $paymentType === PaymentType::DIRECT_DEBIT ) {
			return Donation::STATUS_NEW;
		}

		if ( $paymentType === PaymentType::BANK_TRANSFER ) {
			return Donation::STATUS_PROMISE;
		}

		return Donation::STATUS_EXTERNAL_INCOMPLETE;
	}

	private function getPaymentFromRequest( AddDonationRequest $donationRequest ): DonationPayment {
		return new DonationPayment(
			$donationRequest->getAmount(),
			$donationRequest->getInterval(),
			$this->getPaymentMethodFromRequest( $donationRequest )
		);
	}

	private function getPaymentMethodFromRequest( AddDonationRequest $donationRequest ): PaymentMethod {
		if ( $donationRequest->getPaymentType() === PaymentType::BANK_TRANSFER ) {
			return new BankTransferPayment( $this->transferCodeGenerator->generateTransferCode() );
		}

		if ( $donationRequest->getPaymentType() === PaymentType::DIRECT_DEBIT ) {
			return new DirectDebitPayment( $donationRequest->getBankData() );
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
		}

		if ( $donationRequest->getPaymentType() === PaymentType::PAYPAL ) {
			return new PayPalPayment( new PayPalData() );
		}

		return new PaymentWithoutAssociatedData( $donationRequest->getPaymentType() );
	}

	private function newTrackingInfoFromRequest( AddDonationRequest $request ): DonationTrackingInfo {
		$trackingInfo = new DonationTrackingInfo();

		$trackingInfo->setTracking( $request->getTracking() );
		$trackingInfo->setSource( $this->referrerGeneralizer->generalize( $request->getSource() ) );
		$trackingInfo->setTotalImpressionCount( $request->getTotalImpressionCount() );
		$trackingInfo->setSingleBannerImpressionCount( $request->getSingleBannerImpressionCount() );
		$trackingInfo->setColor( $request->getColor() );
		$trackingInfo->setSkin( $request->getSkin() );
		$trackingInfo->setLayout( $request->getLayout() );

		return $trackingInfo->freeze()->assertNoNullFields();
	}

	/**
	 * @param Donation $donation
	 *
	 * @throws \RuntimeException
	 * TODO: handle exception
	 */
	private function sendDonationConfirmationEmail( Donation $donation ) {
		if ( $donation->getDonor() !== null && !$donation->hasExternalPayment() ) {
			$this->mailer->sendConfirmationMailFor( $donation );
		}
	}
}

1			<?php
2
3			declare( strict_types = 1 );
4
5			namespace WMDE\Fundraising\Frontend\DonatingContext\UseCases\AddDonation;
6
7			use WMDE\Fundraising\Frontend\Domain\Model\PersonName;
8			use WMDE\Fundraising\Frontend\Domain\Model\PhysicalAddress;
9			use WMDE\Fundraising\Frontend\DonatingContext\Authorization\DonationTokenFetcher;
10			use WMDE\Fundraising\Frontend\DonatingContext\Domain\Model\Donation;
11			use WMDE\Fundraising\Frontend\DonatingContext\Domain\Model\DonationPayment;
12			use WMDE\Fundraising\Frontend\DonatingContext\Domain\Model\DonationTrackingInfo;
13			use WMDE\Fundraising\Frontend\DonatingContext\Domain\Model\Donor;
14			use WMDE\Fundraising\Frontend\DonatingContext\Domain\Repositories\DonationRepository;
15			use WMDE\Fundraising\Frontend\DonatingContext\Infrastructure\DonationConfirmationMailer;
16			use WMDE\Fundraising\Frontend\PaymentContext\Domain\Model\BankTransferPayment;
17			use WMDE\Fundraising\Frontend\PaymentContext\Domain\Model\DirectDebitPayment;
18			use WMDE\Fundraising\Frontend\PaymentContext\Domain\Model\PaymentMethod;
19			use WMDE\Fundraising\Frontend\PaymentContext\Domain\Model\PaymentType;
20			use WMDE\Fundraising\Frontend\PaymentContext\Domain\Model\PaymentWithoutAssociatedData;
21			use WMDE\Fundraising\Frontend\PaymentContext\Domain\Model\PayPalData;
22			use WMDE\Fundraising\Frontend\PaymentContext\Domain\Model\PayPalPayment;
23			use WMDE\Fundraising\Frontend\PaymentContext\Domain\TransferCodeGenerator;
24
25			/**
26			* @license GNU GPL v2+
27			* @author Kai Nissen < [email protected] >
28			* @author Jeroen De Dauw < [email protected] >
29			*/
30			class AddDonationUseCase {
31
32			private $donationRepository;
33			private $donationValidator;
34			private $policyValidator;
35			private $referrerGeneralizer;
36			private $mailer;
37			private $transferCodeGenerator;
38			private $tokenFetcher;
39
40			public function __construct( DonationRepository $donationRepository, AddDonationValidator $donationValidator,
41			AddDonationPolicyValidator $policyValidator, ReferrerGeneralizer $referrerGeneralizer,
42			DonationConfirmationMailer $mailer, TransferCodeGenerator $transferCodeGenerator,
43			DonationTokenFetcher $tokenFetcher ) {
44			$this->donationRepository = $donationRepository;
45			$this->donationValidator = $donationValidator;
46			$this->policyValidator = $policyValidator;
47			$this->referrerGeneralizer = $referrerGeneralizer;
48			$this->mailer = $mailer;
49			$this->transferCodeGenerator = $transferCodeGenerator;
50
51			$this->tokenFetcher = $tokenFetcher;
52			}
53
54			public function addDonation( AddDonationRequest $donationRequest ): AddDonationResponse {
55			$validationResult = $this->donationValidator->validate( $donationRequest );
56
57			if ( $validationResult->hasViolations() ) {
58			return AddDonationResponse::newFailureResponse( $validationResult->getViolations() );
59			}
60
61			$donation = $this->newDonationFromRequest( $donationRequest );
62
63			if ( $this->policyValidator->needsModeration( $donationRequest ) ) {
64			$donation->markForModeration();
65			}
66
67			// TODO: handle exceptions
68			$this->donationRepository->storeDonation( $donation );
69
70			// TODO: handle exceptions
71			$tokens = $this->tokenFetcher->getTokens( $donation->getId() );
72
73			$this->sendDonationConfirmationEmail( $donation );
74
75			return AddDonationResponse::newSuccessResponse(
76			$donation,
77			$tokens->getUpdateToken(),
78			$tokens->getAccessToken()
79			);
80			}
81
82			private function newDonationFromRequest( AddDonationRequest $donationRequest ): Donation {
83			return new Donation(
84			null,
85			$this->getInitialDonationStatus( $donationRequest->getPaymentType() ),
86			$this->getPersonalInfoFromRequest( $donationRequest ),
87			$this->getPaymentFromRequest( $donationRequest ),
88			$donationRequest->getOptIn() === '1',
89			$this->newTrackingInfoFromRequest( $donationRequest )
90			);
91			}
92
93			private function getPersonalInfoFromRequest( AddDonationRequest $request ) {
94			if ( $request->donorIsAnonymous() ) {
95			return null;
96			}
97			return new Donor(
98			$this->getNameFromRequest( $request ),
99			$this->getPhysicalAddressFromRequest( $request ),
100			$request->getDonorEmailAddress()
101			);
102			}
103
104			private function getPhysicalAddressFromRequest( AddDonationRequest $request ): PhysicalAddress {
105			$address = new PhysicalAddress();
106
107			$address->setStreetAddress( $request->getDonorStreetAddress() );
108			$address->setPostalCode( $request->getDonorPostalCode() );
109			$address->setCity( $request->getDonorCity() );
110			$address->setCountryCode( $request->getDonorCountryCode() );
111
112			return $address->freeze()->assertNoNullFields();
113			}
114
115			private function getNameFromRequest( AddDonationRequest $request ): PersonName {
116			$name = $request->donorIsCompany() ? PersonName::newCompanyName() : PersonName::newPrivatePersonName();
117
118			$name->setSalutation( $request->getDonorSalutation() );
119			$name->setTitle( $request->getDonorTitle() );
120			$name->setCompanyName( $request->getDonorCompany() );
121			$name->setFirstName( $request->getDonorFirstName() );
122			$name->setLastName( $request->getDonorLastName() );
123
124			return $name->freeze()->assertNoNullFields();
125			}
126
127			private function getInitialDonationStatus( string $paymentType ): string {
128			if ( $paymentType === PaymentType::DIRECT_DEBIT ) {
129			return Donation::STATUS_NEW;
130			}
131
132			if ( $paymentType === PaymentType::BANK_TRANSFER ) {
133			return Donation::STATUS_PROMISE;
134			}
135
136			return Donation::STATUS_EXTERNAL_INCOMPLETE;
137			}
138
139			private function getPaymentFromRequest( AddDonationRequest $donationRequest ): DonationPayment {
140			return new DonationPayment(
141			$donationRequest->getAmount(),
142			$donationRequest->getInterval(),
143			$this->getPaymentMethodFromRequest( $donationRequest )
144			);
145			}
146
147			private function getPaymentMethodFromRequest( AddDonationRequest $donationRequest ): PaymentMethod {
148			if ( $donationRequest->getPaymentType() === PaymentType::BANK_TRANSFER ) {
149			return new BankTransferPayment( $this->transferCodeGenerator->generateTransferCode() );
150			}
151
152			if ( $donationRequest->getPaymentType() === PaymentType::DIRECT_DEBIT ) {
153			return new DirectDebitPayment( $donationRequest->getBankData() );
			0 ignored issues – show Bug introduced 2016-07-25 15:13 UTC by Report Bug Copy Issue Report It seems like `$donationRequest->getBankData()` can be `null`; however, `__construct()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
154			}
155
156			if ( $donationRequest->getPaymentType() === PaymentType::PAYPAL ) {
157			return new PayPalPayment( new PayPalData() );
158			}
159
160			return new PaymentWithoutAssociatedData( $donationRequest->getPaymentType() );
161			}
162
163			private function newTrackingInfoFromRequest( AddDonationRequest $request ): DonationTrackingInfo {
164			$trackingInfo = new DonationTrackingInfo();
165
166			$trackingInfo->setTracking( $request->getTracking() );
167			$trackingInfo->setSource( $this->referrerGeneralizer->generalize( $request->getSource() ) );
168			$trackingInfo->setTotalImpressionCount( $request->getTotalImpressionCount() );
169			$trackingInfo->setSingleBannerImpressionCount( $request->getSingleBannerImpressionCount() );
170			$trackingInfo->setColor( $request->getColor() );
171			$trackingInfo->setSkin( $request->getSkin() );
172			$trackingInfo->setLayout( $request->getLayout() );
173
174			return $trackingInfo->freeze()->assertNoNullFields();
175			}
176
177			/**
178			* @param Donation $donation
179			*
180			* @throws \RuntimeException
181			* TODO: handle exception
182			*/
183			private function sendDonationConfirmationEmail( Donation $donation ) {
184			if ( $donation->getDonor() !== null && !$donation->hasExternalPayment() ) {
185			$this->mailer->sendConfirmationMailFor( $donation );
186			}
187			}
188			}

wmde / FundraisingFrontend

Pull Request — master (#594)

AddDonationUseCase::newDonationFromRequest() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like