ContactContext::iShouldBeNotifiedThatAProblemOccuredWhileSendingTheContactRequest() - Code Metrics - Inspection of "[Behat] Delete unused step definitions" - pamil/Sylius - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — unused-definitions ( d9908f )

by Kamil

created 2016-12-21 14:50 UTC

iShouldBeNotifiedThatAProblemOccuredWhileSendingTheContactRequest() A

↳ Parent: ContactContext

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	7
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	4
nc	1
nop	0

<?php

/*
 * This file is part of the Sylius package.
 *
 * (c) Paweł Jędrzejewski
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Sylius\Behat\Context\Ui\Shop;

use Behat\Behat\Context\Context;
use Sylius\Behat\NotificationType;
use Sylius\Behat\Page\PageInterface;
use Sylius\Behat\Page\Shop\Contact\ContactPageInterface;
use Sylius\Behat\Service\NotificationCheckerInterface;
use Webmozart\Assert\Assert;

/**
 * @author Grzegorz Sadowski <[email protected]>
 */
final class ContactContext implements Context
{
    /**
     * @var ContactPageInterface
     */
    private $contactPage;

    /**
     * @var NotificationCheckerInterface
     */
    private $notificationChecker;

    /**
     * @param ContactPageInterface $contactPage
     * @param NotificationCheckerInterface $notificationChecker
     */
    public function __construct(
        ContactPageInterface $contactPage,
        NotificationCheckerInterface $notificationChecker
    ) {
        $this->contactPage = $contactPage;
        $this->notificationChecker = $notificationChecker;
    }

    /**
     * @When I want to request contact
     */
    public function iWantToRequestContact()
    {
        $this->contactPage->open();
    }

    /**
     * @When I specify the email as :email
     * @When I do not specify the email
     */
    public function iSpecifyTheEmail($email = null)
    {
        $this->contactPage->specifyEmail($email);
    }

    /**
     * @When I specify the message as :message
     * @When I do not specify the message
     */
    public function iSpecifyTheMessage($message = null)
    {
        $this->contactPage->specifyMessage($message);
    }

    /**
     * @When I send it
     * @When I try to send it
     */
    public function iSendIt()
    {
        $this->contactPage->send();
    }

    /**
     * @Then I should be notified that the contact request has been submitted successfully
     */
    public function iShouldBeNotifiedThatTheContactRequestHasBeenSubmittedSuccessfully()
    {
        $this->notificationChecker->checkNotification(
            'Your contact request has been submitted successfully.',
            NotificationType::success()
        );
    }

    /**
     * @Then /^I should be notified that the (email|message) is required$/
     */
    public function iShouldBeNotifiedThatElementIsRequired($element)
    {
        $this->assertFieldValidationMessage(
            $this->contactPage,
            $element,
            sprintf('Please enter your %s.', $element)
        );
    }

    /**
     * @Then I should be notified that the email is invalid
     */
    public function iShouldBeNotifiedThatEmailIsInvalid()
    {
        $this->assertFieldValidationMessage(
            $this->contactPage,
            'email',
            'This email is invalid.'
        );
    }

    /**
     * @Then I should be notified that a problem occured while sending the contact request
     */
    public function iShouldBeNotifiedThatAProblemOccuredWhileSendingTheContactRequest()
    {
        $this->notificationChecker->checkNotification(
            'A problem occurred while sending the contact request. Please try again later.',
            NotificationType::failure()
        );
    }

    /**
     * @param PageInterface $page
     * @param string $element
     * @param string $expectedMessage
     */
    private function assertFieldValidationMessage(PageInterface $page, $element, $expectedMessage)
    {
        $currentMessage = $page->getValidationMessageFor($element);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

        Assert::same(
            $currentMessage,
            $expectedMessage,
            'There is a message: "%s", but should be: "%s".'
        );
    }
}


1			<?php
2
3			/*
4			* This file is part of the Sylius package.
5			*
6			* (c) Paweł Jędrzejewski
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			namespace Sylius\Behat\Context\Ui\Shop;
13
14			use Behat\Behat\Context\Context;
15			use Sylius\Behat\NotificationType;
16			use Sylius\Behat\Page\PageInterface;
17			use Sylius\Behat\Page\Shop\Contact\ContactPageInterface;
18			use Sylius\Behat\Service\NotificationCheckerInterface;
19			use Webmozart\Assert\Assert;
20
21			/**
22			* @author Grzegorz Sadowski <[email protected]>
23			*/
24			final class ContactContext implements Context
25			{
26			/**
27			* @var ContactPageInterface
28			*/
29			private $contactPage;
30
31			/**
32			* @var NotificationCheckerInterface
33			*/
34			private $notificationChecker;
35
36			/**
37			* @param ContactPageInterface $contactPage
38			* @param NotificationCheckerInterface $notificationChecker
39			*/
40			public function __construct(
41			ContactPageInterface $contactPage,
42			NotificationCheckerInterface $notificationChecker
43			) {
44			$this->contactPage = $contactPage;
45			$this->notificationChecker = $notificationChecker;
46			}
47
48			/**
49			* @When I want to request contact
50			*/
51			public function iWantToRequestContact()
52			{
53			$this->contactPage->open();
54			}
55
56			/**
57			* @When I specify the email as :email
58			* @When I do not specify the email
59			*/
60			public function iSpecifyTheEmail($email = null)
61			{
62			$this->contactPage->specifyEmail($email);
63			}
64
65			/**
66			* @When I specify the message as :message
67			* @When I do not specify the message
68			*/
69			public function iSpecifyTheMessage($message = null)
70			{
71			$this->contactPage->specifyMessage($message);
72			}
73
74			/**
75			* @When I send it
76			* @When I try to send it
77			*/
78			public function iSendIt()
79			{
80			$this->contactPage->send();
81			}
82
83			/**
84			* @Then I should be notified that the contact request has been submitted successfully
85			*/
86			public function iShouldBeNotifiedThatTheContactRequestHasBeenSubmittedSuccessfully()
87			{
88			$this->notificationChecker->checkNotification(
89			'Your contact request has been submitted successfully.',
90			NotificationType::success()
91			);
92			}
93
94			/**
95			* @Then /^I should be notified that the (email\|message) is required$/
96			*/
97			public function iShouldBeNotifiedThatElementIsRequired($element)
98			{
99			$this->assertFieldValidationMessage(
100			$this->contactPage,
101			$element,
102			sprintf('Please enter your %s.', $element)
103			);
104			}
105
106			/**
107			* @Then I should be notified that the email is invalid
108			*/
109			public function iShouldBeNotifiedThatEmailIsInvalid()
110			{
111			$this->assertFieldValidationMessage(
112			$this->contactPage,
113			'email',
114			'This email is invalid.'
115			);
116			}
117
118			/**
119			* @Then I should be notified that a problem occured while sending the contact request
120			*/
121			public function iShouldBeNotifiedThatAProblemOccuredWhileSendingTheContactRequest()
122			{
123			$this->notificationChecker->checkNotification(
124			'A problem occurred while sending the contact request. Please try again later.',
125			NotificationType::failure()
126			);
127			}
128
129			/**
130			* @param PageInterface $page
131			* @param string $element
132			* @param string $expectedMessage
133			*/
134			private function assertFieldValidationMessage(PageInterface $page, $element, $expectedMessage)
135			{
136			$currentMessage = $page->getValidationMessageFor($element);
			0 ignored issues – show Bug introduced 2016-12-21 15:08 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Sylius\Behat\Page\PageInterface` as the method `getValidationMessageFor()` does only exist in the following implementations of said interface: `Sylius\Behat\Page\Shop\Contact\ContactPage`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
137
138			Assert::same(
139			$currentMessage,
140			$expectedMessage,
141			'There is a message: "%s", but should be: "%s".'
142			);
143			}
144			}
145

pamil / Sylius

Push — unused-definitions ( d9908f )

iShouldBeNotifiedThatAProblemOccuredWhileSendingTheContactRequest() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like