Merge pull request #4 from integer-net/20211001-update

Update module

Author: lbuchholz

CHANGELOG.md

@@ -4,8 +4,8 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
-## [Unreleased]
+##[0.0.1] - 2021-10-01
 ### Added
+- Services to set and unset mock data
 ### Changed
-### Removed
-### Fixed
+- improved module structure

README.md

@@ -10,11 +10,12 @@
 [![Maintainability][ico-maintainability]][link-maintainability]
 </div>
 
-# IntegerNet ShippingPreselection (AutoShipping) 
+# IntegerNet ShippingPreselection (AutoShipping)
 
-This module provides methods to preselect a shipping method upon quote creation of the customer. It fetches all available countries from Magento Config and will preselect the default country/region/postcode of the current storeview.
+This module preselects the cheapest shipping method by filling shipping address with mock data and default country/region/postcode of the current storeview.
+
+Upon entering checkout, PayPal Express or PayOne pages, the mock data is removed from shipping address.
 
-**Important:** This is WIP as of yet - shipping address mock data still needs to be cleared when entering checkout.
 
 
 ## Installation
@@ -32,76 +33,99 @@ This module provides methods to preselect a shipping method upon quote creation
 
 ## Configuration
 
-In general, make sure your configuration settings meet requirements: 
+In general, make sure your configuration settings meet requirements:
 
 - postcode, region and country set in General > Store Information
 - all available countries need to have at least one shipping method available
 - available countries cannot have mandatory region setting
 
 1) Add selectedShippingCountry select to `Mage_Checkout::cart.phtml`
- 
- 
+
+
 ```
      <?= $block->getChildHtml('shipping_country') ?>
 
 ```
 2. Add shipping country script to `Mage_Checkout::cart/js/cart.phtml`
- 
+
 ```
      updateCartDataDependencies() {
          [...]
          this.selectedShippingCountry = this.cartData && this.cartData.shipping_addresses && this.cartData.shipping_addresses[0] && this.cartData.shipping_addresses[0].country && this.cartData.shipping_addresses[0].country.code || null
      },
      <?= $block->getChildHtml('shipping_country_js') ?>
 ```
- 
 
-3) Set config value for the mock data `integernet/shipping_preselection/mock_data` to custom value if desired 
- 
+
+3) Set config value for the mock data `integernet/shipping_preselection/mock_data` to custom value if desired
+
 4) If you have an altered cart query for GraphQl, you need to override `IntegerNet\ShippingPreselection\ViewModel\ShippingAddressMutation` accordingly.
 
-## Usage
 
-## Changelog
+.
 
-Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
+Please mind: *The template provided is supposed to work with table rates / one shipping method.*
 
-## Contributing
+If you have several shipping methods and through changes made in cart - like quantity changes - the best available method changes, this will not be recognized by the module (because a shipping method is already in place). You can solve this by checking client-side in the cart, or adding a check backend-wise. 
 
-Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
+## Extending configuration
 
-## Testing
+Override config values for integernet/shipping_preselection/mock_clearance_urls or hook into the service to modify behaviour for pages where the shipping address should be (un-)mocked.
 
-### Unit Tests
+## Known issues
 
-```
-./vendor/bin/phpunit tests/unit
-```
+**1. When aborting PayPal Express and return to cart, the shipping method isn't displayed anymore**
 
-### Magento Integration Tests
+Paypal doesn't properly set the telephone address attribute, as it is called differently in its response. You can make the telephone field nullable in a `etc/schema.graphql` of your own
 
-0. Configure test database in `dev/tests/integration/etc/install-config-mysql.php`. [Read more in the Magento docs.](https://devdocs.magento.com/guides/v2.4/test/integration/integration_test_execution.html) 
 
-1. Copy `tests/integration/phpunit.xml.dist` from the package to `dev/tests/integration/phpunit.xml` in your Magento installation.
+    interface CartAddressInterface {
+        telephone: String
+    }
+    
+    input CartAddressInput {
+        telephone: String
+    }
 
-2. In that directory, run
-    ``` bash
-    ../../../vendor/bin/phpunit
-    ```
+
+
+
+## Changelog
+
+Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
+
+## Contributing
+
+Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
 
 ## Security
 
 If you discover any security related issues, please email security@integer-net.de instead of using the issue tracker.
 
 ## Credits
 
-- [Lisa Buchholz][link-author]
+- [integer_net GmbH][link-author]
 - [All Contributors][link-contributors]
 
 ## License
 
 The MIT License (MIT). Please see [License File](LICENSE) for more information.
 
+[ico-version]: https://img.shields.io/packagist/v/integer-net/magento2-shippingpreselection.svg?style=flat-square
+[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
+[ico-code-quality]: https://img.shields.io/scrutinizer/g/integer-net/magento2-shippingpreselection.svg?style=flat-square
+[ico-maintainability]: https://img.shields.io/codeclimate/maintainability/integer-net/magento2-shippingpreselection?style=flat-square
+[ico-compatibility]: https://img.shields.io/badge/magento-2.4-brightgreen.svg?logo=magento&longCache=true&style=flat-square
+
+[link-packagist]: https://packagist.org/packages/integer-net/magento2-shippingpreselection
+[link-scrutinizer]: https://scrutinizer-ci.com/g/integer-net/magento2-shippingpreselection/code-structure
+[link-code-quality]: https://scrutinizer-ci.com/g/integer-net/magento2-shippingpreselection
+[link-maintainability]: https://codeclimate.com/github/integer-net/magento2-shippingpreselection
+[link-author]: https://github.com/integer_net
+[link-contributors]: ../../contributors
+
+
+
 [ico-version]: https://img.shields.io/packagist/v/integer-net/magento2-shippingpreselection.svg?style=flat-square
 [ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
 [ico-travis]: https://img.shields.io/travis/integer-net/magento2-shippingpreselection/master.svg?style=flat-square

src/ExampleClass.php

@@ -1,50 +1,53 @@
 <?php
 declare(strict_types=1);
 
-// phpcs:disable PSR2.Methods.FunctionCallSignature.Indent
-
 namespace IntegerNet\ShippingPreselection\Plugin;
 
+use IntegerNet\ShippingPreselection\Service\AddressSetMockdata;
+use IntegerNet\ShippingPreselection\Service\AddressResetConditions;
 use Magento\Checkout\Model\Session;
 use Magento\Quote\Model\Quote;
+use Magento\Quote\Model\Quote\Address;
 use Magento\Quote\Model\Quote\Address\Rate;
 use Magento\Quote\Model\Quote\AddressFactory;
 use Magento\Quote\Model\ShippingMethodManagement;
 use Magento\Framework\App\Config\ScopeConfigInterface;
 
 class PreselectShippingMethod
 {
-    private ScopeConfigInterface     $storeConfig;
     private ShippingMethodManagement $shippingMethodManagement;
     private AddressFactory           $addressFactory;
-
-    private const CONFIG_PATH_DEFAULT_COUNTRY_ID = 'general/country/default';
-    private const CONFIG_PATH_DEFAULT_REGION_ID  = 'general/store_information/region_id';
-    private const CONFIG_PATH_DEFAULT_POSTCODE   = 'general/store_information/postcode';
-    private const CONFIG_PATH_MOCK_DATASET       = 'integernet/shipping_preselection/mock_data';
+    private AddressSetMockdata       $addressSetMockdata;
+    private AddressResetConditions   $addressResetConditions;
 
     public function __construct(
         ScopeConfigInterface $storeConfig,
         ShippingMethodManagement $shippingMethodManagement,
-        AddressFactory $addressFactory)
+        AddressFactory $addressFactory,
+        AddressResetConditions $addressResetConditions,
+        AddressSetMockdata $addressSetMockdata)
     {
         $this->storeConfig = $storeConfig;
         $this->shippingMethodManagement = $shippingMethodManagement;
         $this->addressFactory = $addressFactory;
+        $this->addressSetMockdata = $addressSetMockdata;
+        $this->addressResetConditions = $addressResetConditions;
     }
 
     /**
      * @SuppressWarnings(PHPMD.UnusedFormalParameter)
      */
     public function afterGetQuote(Session $subject, Quote $result): Quote
     {
-        if (!$result->getIsVirtual() && $result->getItemsCount()) {
-            if (!$result->getShippingAddress()
-                || $result->getShippingAddress() && !$result->getShippingAddress()->getShippingMethod()) {
-                $this->prepareShippingAddress($result);
+        if (!$this->addressResetConditions->isAddressResetRequest() && !$this->addressResetConditions->isAddressIgnoreRequest()) {
+            if (!$result->getIsVirtual() && $result->getItemsCount()) {
+                $shippingAddress = $result->getShippingAddress();
+                if (!$shippingAddress || !$shippingAddress->validate() || !$shippingAddress->getShippingMethod()) {
+                    $this->prepareShippingAddress($shippingAddress, $result);
+                }
+
+                $this->prepareShippingRates($result);
             }
-
-            $this->prepareShippingRates($result);
         }
 
         return $result;
@@ -54,57 +57,28 @@ public function afterGetQuote(Session $subject, Quote $result): Quote
      * GraphQl requires fully valid address data to work with in cart, so we need to make up data if
      * it has not been set yet
      *
-     * @param Quote $quote
-     * @return Quote
+     * @param Address $quote
      * @SuppressWarnings(PHPMD.CyclomaticComplexity)
      * @SuppressWarnings(PHPMD.NPathComplexity)
      */
-    private function prepareShippingAddress(Quote $quote): Quote
+    private function prepareShippingAddress(Address $shippingAddress, Quote $quote): void
     {
-        $address = $quote->getShippingAddress();
-
-        if (!$address) {
-            $address = $this->addressFactory->create();
-            $address->setQuote($quote);
+        if (!$shippingAddress) {
+            $shippingAddress = $this->addressFactory->create();
+            $shippingAddress->setQuote($quote);
         }
 
-        if ($address->validate() !== true) {
-            $prefill = $this->storeConfig->getValue(self::CONFIG_PATH_MOCK_DATASET, 'store');
-
-            $address->setFirstname($address->getFirstname() ?: $prefill);
-            $address->setLastname($address->getLastname() ?: $prefill);
-            $address->setPostcode(
-                $address->getPostcode() ?: $this->storeConfig->getValue(self::CONFIG_PATH_DEFAULT_POSTCODE, 'store')
-            );
-            $address->setCity($address->getCity() ?: $prefill);
-            $address->setTelephone($address->getTelephone() ?: $prefill);
-            $address->setRegion(
-                $address->getRegion() ?: $this->storeConfig->getValue(self::CONFIG_PATH_DEFAULT_REGION_ID, 'store')
-            );
-            $address->setCountryId(
-                $address->getData('country_id')
-                    ?: $this->storeConfig->getValue(
-                    self::CONFIG_PATH_DEFAULT_COUNTRY_ID,
-                    'store'
-                )
-            );
-            $address->setStreet(
-                (is_array($address->getStreet()) && count($address->getStreet()) && $address->getStreet()[0] !== '')
-                || is_string($address->getStreet()) && strlen($address->getStreet()) ? $address->getStreet()
-                    : [$prefill]
-            );
+        if ($shippingAddress->validate() !== true) {
+            $this->addressSetMockdata->setMockDataOnAddress($shippingAddress);
         }
-
-        return $quote;
     }
 
     /**
      * try setting cheapest shipping rate available for customer
      *
      * @param Quote $quote
-     * @return Quote
      */
-    private function prepareShippingRates(Quote $quote): Quote
+    private function prepareShippingRates(Quote $quote): void
     {
         $quote->getShippingAddress()->requestShippingRates();
         $rates = $quote->getShippingAddress()->getShippingRatesCollection();
@@ -129,7 +103,5 @@ private function prepareShippingRates(Quote $quote): Quote
                 $quote->addErrorInfo('error', null, $e->getCode(), $e->getMessage());
             }
         }
-
-        return $quote;
     }
 }

src/Plugin/PreselectShippingMethod.php

@@ -0,0 +1,45 @@
+<?php
+declare(strict_types=1);
+
+namespace IntegerNet\ShippingPreselection\Plugin;
+
+use Magento\Checkout\Model\Session;
+use Magento\Quote\Model\Quote;
+use IntegerNet\ShippingPreselection\Service\AddressUnsetMockdata;
+use IntegerNet\ShippingPreselection\Service\AddressResetConditions;
+
+class ResetShippingAddress
+{
+
+    private AddressUnsetMockdata   $addressUnsetMockdata;
+    private AddressResetConditions $addressResetConditions;
+    private                        $resetUrls = null;
+
+    public function __construct(
+        AddressUnsetMockdata $addressUnsetMockdata,
+        AddressResetConditions $addressResetConditions)
+    {
+        $this->addressUnsetMockdata = $addressUnsetMockdata;
+        $this->addressResetConditions = $addressResetConditions;
+    }
+
+    /**
+     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
+     */
+    public function afterGetQuote(Session $subject, Quote $result): Quote
+    {
+        if ($this->addressResetConditions->isAddressResetRequest()) {
+            if (!$result->getIsVirtual() && $result->getItemsCount()) {
+                $shippingAddress = $result->getShippingAddress();
+
+                if ($this->addressUnsetMockdata->isMockedAddress($shippingAddress)) {
+                    $this->addressUnsetMockdata->resetShippingAddress($result);
+                } else {
+                    $this->addressUnsetMockdata->checkForEmptyAddressFields($shippingAddress);
+                }
+            }
+        }
+
+        return $result;
+    }
+}