Sylius\Behat\Context\Ui\Shop\ProductContext

Complexity

Total Complexity

46

Size/Duplication

Total Lines	522
Duplicated Lines	0 %

Coupling/Cohesion

Components	3
Dependencies	6

Importance

Changes

0

43 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	9	1
A	iShouldBeAbleToAccessProduct()	0	9	1
A	iShouldNotBeAbleToAccessProduct()	0	9	1
A	iOpenProductPage()	0	4	1
A	iShouldSeeProductName()	0	8	1
A	iOpenPage()	0	4	1
A	iShouldBeOnProductDetailedPage()	0	7	1
A	iShouldSeeTheProductAttributeWithValue()	0	14	1
A	iShouldSeeAttributes()	0	10	1
A	theFirstAttributeShouldBe()	0	11	1
A	theLastAttributeShouldBe()	0	11	1
A	iCheckListOfProductsForTaxon()	0	4	1
A	iSearchForProductsWithName()	0	4	1
A	iClearFilter()	0	4	1
A	iShouldSeeProduct()	0	7	1
A	iShouldNotSeeProduct()	0	7	1
A	iShouldSeeEmptyListOfProducts()	0	7	1
A	iShouldSeeItIsOutOfStock()	0	7	1
A	iShouldBeUnableToAddItToTheCart()	0	7	1
A	iShouldSeeTheProductPrice()	0	8	1
A	iSetItsOptionTo()	0	4	1
A	iSelectVariant()	0	4	1
A	iShouldSeeTheProductWithPrice()	0	7	1
A	iShouldBeNotifiedThatThisProductDoesNotHaveSufficientStock()	0	9	1
A	iShouldNotBeNotifiedThatThisProductDoesNotHaveSufficientStock()	0	7	1
A	iShouldSeeAMainImage()	0	7	1
A	iViewSortedProductsFromTaxon()	0	6	2
A	iShouldSeeProductsInTheList()	0	10	1
A	iShouldSeeProductWithName()	0	7	1
A	theFirstProductOnTheListShouldHaveName()	0	10	1
A	iShouldSeeProductReviews()	0	8	1
A	iShouldSeeReviewsTitled()	0	9	2
A	iShouldNotSeeReviewTitled()	0	7	1
A	iCheckThisProductSReviews()	0	4	1
A	iShouldSeeNumberOfProductReviewsInTheList()	0	8	1
A	iShouldNotSeeReviewTitledInTheList()	0	7	1
A	iShouldBeNotifiedThatThereAreNoReviews()	0	7	1
A	iShouldSeeAsItsAverageRating()	0	10	1
A	iShouldSeeTheProductAssociationWithProducts()	0	11	2
A	thisProductAverageRatingShouldBe()	0	5	1
A	theyShouldHaveOrderLikeAnd()	0	7	1
A	assertIsProductIsInAssociation()	0	11	1
A	getProductAttributes()	0	7	1

<?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 Behat\Mink\Element\NodeElement;
use Sylius\Behat\Page\Shop\Product\ShowPageInterface;
use Sylius\Behat\Page\Shop\ProductReview\IndexPageInterface;
use Sylius\Behat\Page\Shop\Taxon\ShowPageInterface as TaxonShowPageInterface;
use Sylius\Component\Core\Model\ProductInterface;
use Sylius\Component\Core\Model\TaxonInterface;
use Webmozart\Assert\Assert;

/**
 * @author Kamil Kokot <kamil.kokot@lakion.com>
 * @author Magdalena Banasiak <magdalena.banasiak@lakion.com>
 * @author Anna Walasek <anna.walasek@lakion.com>
 */
final class ProductContext implements Context
{
    /**
     * @var ShowPageInterface
     */
    private $showPage;

    /**
     * @var TaxonShowPageInterface
     */
    private $taxonShowPage;

    /**
     * @var IndexPageInterface
     */
    private $productReviewsIndexPage;

    /**
     * @param ShowPageInterface $showPage
     * @param TaxonShowPageInterface $taxonShowPage
     * @param IndexPageInterface $productReviewsIndexPage
     */
    public function __construct(
        ShowPageInterface $showPage,
        TaxonShowPageInterface $taxonShowPage,
        IndexPageInterface $productReviewsIndexPage
    ) {
        $this->showPage = $showPage;
        $this->taxonShowPage = $taxonShowPage;
        $this->productReviewsIndexPage = $productReviewsIndexPage;
    }

    /**
     * @Then I should be able to access product :product
     */
    public function iShouldBeAbleToAccessProduct(ProductInterface $product)
    {
        $this->showPage->tryToOpen(['slug' => $product->getSlug()]);

        Assert::true(
            $this->showPage->isOpen(['slug' => $product->getSlug()]),
            'Product show page should be open, but it does not.'
        );
    }

    /**
     * @Then I should not be able to access product :product
     */
    public function iShouldNotBeAbleToAccessProduct(ProductInterface $product)
    {
        $this->showPage->tryToOpen(['slug' => $product->getSlug()]);

        Assert::false(
            $this->showPage->isOpen(['slug' => $product->getSlug()]),
            'Product show page should not be open, but it does.'
        );
    }

    /**
     * @When /^I check (this product)'s details/
     * @When I view product :product
     */
    public function iOpenProductPage(ProductInterface $product)
    {
        $this->showPage->open(['slug' => $product->getSlug()]);
    }

    /**
     * @Given I should see the product name :name
     */
    public function iShouldSeeProductName($name)
    {
        Assert::same(
            $name,
            $this->showPage->getName(),
            'Product should have name %2$s, but it has %s'
        );
    }

    /**
     * @When I open page :url
     */
    public function iOpenPage($url)
    {
        $this->showPage->visit($url);
    }

    /**
     * @Then I should be on :product product detailed page
     * @Then I should still be on product :product page
     */
    public function iShouldBeOnProductDetailedPage(ProductInterface $product)
    {
        Assert::true(
            $this->showPage->isOpen(['slug' => $product->getSlug()]),
            sprintf('Product %s show page should be open, but it does not.', $product->getName())
        );
    }

    /**
     * @Then I should see the product attribute :attributeName with value :expectedAttribute
     */
    public function iShouldSeeTheProductAttributeWithValue($attributeName, $expectedAttribute)
    {
        $certainAttribute = $this->showPage->getAttributeByName($attributeName);
        Assert::same(
            $certainAttribute,
            $expectedAttribute,
            sprintf(
                'Product should have attribute %s with value %s, but has %s.',
                $attributeName,
                $expectedAttribute,
                $certainAttribute
            )
        );
    }

    /**
     * @Then I should see :count attributes
     */
    public function iShouldSeeAttributes($count)
    {
        $attributes = $this->getProductAttributes();

        Assert::same(
            count($attributes),
            (int) $count,
            'Product should have %2$d attributes, but has %d instead.'
        );
    }

    /**
     * @Then the first attribute should be :name
     */
    public function theFirstAttributeShouldBe($name)
    {
        $attributes = $this->getProductAttributes();
        $firstAttribute = reset($attributes);

        Assert::same(
            $firstAttribute->getText(),
            $name,
            'Expected the first attribute to be %2$s, found %s instead.'
        );
    }

    /**
     * @Then the last attribute should be :name
     */
    public function theLastAttributeShouldBe($name)
    {
        $attributes = $this->getProductAttributes();
        $lastAttribute = end($attributes);

        Assert::same(
            $lastAttribute->getText(),
            $name,
            'Expected the first attribute to be %2$s, found %s instead.'
        );
    }

    /**
     * @When /^I browse products from (taxon "([^"]+)")$/
     */
    public function iCheckListOfProductsForTaxon(TaxonInterface $taxon)
    {
        $this->taxonShowPage->open(['slug' => $taxon->getSlug()]);
    }

    /**
     * @When I search for products with name :name
     */
    public function iSearchForProductsWithName($name)
    {
        $this->taxonShowPage->search($name);
    }

    /**
     * @When I clear filter
     */
    public function iClearFilter()
    {
        $this->taxonShowPage->clearFilter();
    }

    /**
     * @Then I should see the product :productName
     */
    public function iShouldSeeProduct($productName)
    {
        Assert::true(
            $this->taxonShowPage->isProductOnList($productName),
            sprintf("The product %s should appear on page, but it does not.", $productName)

The string literal The product %s should appear on page, but it does not. does not require double quotes, as per coding-style, please use single quotes.

        );
    }

    /**
     * @Then I should not see the product :productName
     */
    public function iShouldNotSeeProduct($productName)
    {
        Assert::false(
            $this->taxonShowPage->isProductOnList($productName),
            sprintf("The product %s should not appear on page, but it does.", $productName)

The string literal The product %s should not appear on page, but it does. does not require double quotes, as per coding-style, please use single quotes.

        );
    }

    /**
     * @Then I should see empty list of products
     */
    public function iShouldSeeEmptyListOfProducts()
    {
        Assert::true(
            $this->taxonShowPage->isEmpty(),
            'There should appear information about empty list of products, but it does not.'
        );
    }

    /**
     * @Then I should see that it is out of stock
     */
    public function iShouldSeeItIsOutOfStock()
    {
        Assert::true(
            $this->showPage->isOutOfStock(),
            'Out of stock label should be visible.'
        );
    }

    /**
     * @Then I should be unable to add it to the cart
     */
    public function iShouldBeUnableToAddItToTheCart()
    {
        Assert::false(
            $this->showPage->hasAddToCartButton(),
            'Add to cart button should not be visible.'
        );
    }

    /**
     * @Then the product price should be :price
     * @Then I should see the product price :price
     */
    public function iShouldSeeTheProductPrice($price)
    {
        Assert::same(
            $price,
            $this->showPage->getPrice(),
            'Product should have price %2$s, but it has %s'
        );
    }

    /**
     * @When I set its :optionName to :optionValue
     */
    public function iSetItsOptionTo($optionName, $optionValue)
    {
        $this->showPage->selectOption($optionName, $optionValue);
    }

    /**
     * @When I select :variantName variant
     */
    public function iSelectVariant($variantName)
    {
        $this->showPage->selectVariant($variantName);
    }

    /**
     * @Then I should see the product :productName with price :productPrice
     */
    public function iShouldSeeTheProductWithPrice($productName, $productPrice)
    {
        Assert::true(
            $this->taxonShowPage->isProductWithPriceOnList($productName, $productPrice),
            sprintf("The product %s with price %s should appear on page, but it does not.", $productName, $productPrice)

The string literal The product %s with price %s should appear on page, but it does not. does not require double quotes, as per coding-style, please use single quotes.

        );
    }

    /**
     * @Then /^I should be notified that (this product) does not have sufficient stock$/
     */
    public function iShouldBeNotifiedThatThisProductDoesNotHaveSufficientStock(ProductInterface $product)
    {
       $this->showPage->waitForValidationErrors(3);

        Assert::true(
            $this->showPage->hasProductOutOfStockValidationMessage($product),
            sprintf('I should see validation message for %s product', $product->getName())
        );
    }

    /**
     * @Then /^I should not be notified that (this product) does not have sufficient stock$/
     */
    public function iShouldNotBeNotifiedThatThisProductDoesNotHaveSufficientStock(ProductInterface $product)
    {
        Assert::false(
            $this->showPage->hasProductOutOfStockValidationMessage($product),
            sprintf('I should see validation message for %s product', $product->getName())
        );
    }

    /**
     * @Then I should see a main image
     */
    public function iShouldSeeAMainImage()
    {
        Assert::true(
            $this->showPage->isMainImageDisplayed(),
            'The main image should have been displayed.'
        );
    }

    /**
     * @When /^I view (oldest|newest) products from (taxon "([^"]+)")$/
     */
    public function iViewSortedProductsFromTaxon($sortDirection, TaxonInterface $taxon)
    {
        $sorting = ['createdAt' => 'oldest' === $sortDirection ? 'asc' : 'desc'];

        $this->taxonShowPage->open(['slug' => $taxon->getSlug(), 'sorting' => $sorting]);
    }

    /**
     * @Then I should see :numberOfProducts products in the list
     */
    public function iShouldSeeProductsInTheList($numberOfProducts)
    {
        $foundRows = $this->taxonShowPage->countProductsItems();

        Assert::same(
            (int) $numberOfProducts,
            $foundRows,
            '%s rows with products should appear on page, %s rows has been found'
        );
    }

    /**
     * @Then I should see a product with name :name
     */
    public function iShouldSeeProductWithName($name)
    {
        Assert::true(
            $this->taxonShowPage->isProductOnPageWithName($name),
            sprintf('The product with name "%s" has not been found.', $name)
        );
    }

    /**
     * @Then the first product on the list should have name :name
     */
    public function theFirstProductOnTheListShouldHaveName($name)
    {
        $actualName = $this->taxonShowPage->getFirstProductNameFromList();

        Assert::same(
            $actualName,
            $name,
            sprintf('Expected first product\'s name to be "%s", but it is "%s".', $name, $actualName)
        );
    }

    /**
     * @Then I should see :count product reviews
     */
    public function iShouldSeeProductReviews($count)
    {
        Assert::same(
            (int) $count,
            $this->showPage->countReviews(),
            'Product has %2$s reviews, but should have %s.'
        );
    }

    /**
     * @Then I should see reviews titled :firstReview, :secondReview and :thirdReview
     */
    public function iShouldSeeReviewsTitled(...$reviews)
    {
        foreach ($reviews as $review) {
            Assert::true(
                $this->showPage->hasReviewTitled($review),
                sprintf('Product should have review titled "%s" but it does not.', $review)
            );
        }
    }

    /**
     * @Then I should not see review titled :title
     */
    public function iShouldNotSeeReviewTitled($title)
    {
        Assert::false(
            $this->showPage->hasReviewTitled($title),
            sprintf('Product should not have review titled "%s" but it does.', $title)
        );
    }

    /**
     * @When /^I check (this product)'s reviews$/
     */
    public function iCheckThisProductSReviews(ProductInterface $product)
    {
        $this->productReviewsIndexPage->open(['slug' => $product->getSlug()]);
    }

    /**
     * @Then /^I should see (\d+) product reviews in the list$/
     */
    public function iShouldSeeNumberOfProductReviewsInTheList($count)
    {
        Assert::same(
            (int) $count,
            $this->productReviewsIndexPage->countReviews(),
            'Product has %2$s reviews in the list, but should have %s.'
        );
    }

    /**
     * @Then I should not see review titled :title in the list
     */
    public function iShouldNotSeeReviewTitledInTheList($title)
    {
        Assert::false(
            $this->productReviewsIndexPage->hasReviewTitled($title),
            sprintf('Product should not have review titled "%s" but it does.', $title)
        );
    }

    /**
     * @Then /^I should be notified that there are no reviews$/
     */
    public function iShouldBeNotifiedThatThereAreNoReviews()
    {
        Assert::true(
            $this->productReviewsIndexPage->hasNoReviewMessage(),
            'There should be message about no reviews but there is not.'
        );
    }

    /**
     * @Then I should see :rating as its average rating
     */
    public function iShouldSeeAsItsAverageRating($rating)
    {
        $averageRating = $this->showPage->getAverageRating();

        Assert::same(
            (float) $rating,
            $averageRating,
            'Product should have average rating %2$s but has %s.'
        );
    }

    /**
     * @Then /^I should(?:| also) see the product association "([^"]+)" with (products "[^"]+" and "[^"]+")$/
     */
    public function iShouldSeeTheProductAssociationWithProducts($productAssociationName, array $products)
    {
        Assert::true(
            $this->showPage->hasAssociation($productAssociationName),
            sprintf('There should be an association named "%s" but it does not.', $productAssociationName)
        );

        foreach ($products as $product) {
            $this->assertIsProductIsInAssociation($product->getName(), $productAssociationName);
        }
    }

    /**
     * @Then /^average rating of (product "[^"]+") should be (\d+)$/
     */
    public function thisProductAverageRatingShouldBe(ProductInterface $product, $averageRating)
    {
        $this->showPage->tryToOpen(['slug' => $product->getSlug()]);
        $this->iShouldSeeAsItsAverageRating($averageRating);
    }

    /**
     * @Then they should have order like :firstProductName, :secondProductName and :thirdProductName
     */
    public function theyShouldHaveOrderLikeAnd(...$productNames)
    {
        Assert::true(
            $this->taxonShowPage->hasProductsInOrder($productNames),
            'The products have wrong order.'
        );
    }

    /**
     * @param string $productName
     * @param string $productAssociationName
     *
     * @throws \InvalidArgumentException
     */
    private function assertIsProductIsInAssociation($productName, $productAssociationName)
    {
        Assert::true(
            $this->showPage->hasProductInAssociation($productName, $productAssociationName),
            sprintf(
                'There should be an associated product "%s" under association "%s" but it does not.',
                $productName,
                $productAssociationName
            )
        );
    }

    /**
     * @return NodeElement[]
     *
     * @throws \InvalidArgumentException
     */
    private function getProductAttributes()
    {
        $attributes = $this->showPage->getAttributes();
        Assert::notNull($attributes, 'The product has no attributes.');

        return $attributes;
    }
}