Code refactoring

magepal · May 8, 2020 · 8095b43 · 8095b43
1 parent ad5824d
commit 8095b43
Show file tree

Hide file tree

Showing 15 changed files with 167 additions and 292 deletions.
diff --git a/.github/workflows/php.yml b/.github/workflows/php.yml
@@ -0,0 +1,11 @@
+name: PHPCS
+on: [push]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@master
+    - name: PHPCS
+      run: docker run --rm -v $PWD:/code:ro domw/phpcs phpcs --colors --standard=Magento2 --report=full,summary,gitblame --extensions=php,phtml ./
+    - name: compatibility
+      run: docker run --rm -v $PWD:/code:ro domw/phpcompatibility phpcs --standard=PHPCompatibility --runtime-set testVersion 5.6-7.3 --colors --warning-severity=0 --report=full,summary --extensions=php,phtml ./
diff --git a/Block/Adminhtml/System/Config/Form/Composer/Version.php b/Block/Adminhtml/System/Config/Form/Composer/Version.php
@@ -18,13 +18,8 @@
 use Magento\Framework\Filesystem\Directory\ReadFactory;
 use Magento\Framework\Phrase;
 
-/**
- * Class Version
- * @package MagePal\PreviewCheckoutSuccessPage\Block\Adminhtml\System\Config\Form\Composer
- */
 class Version extends Field
 {
-
     /**
      * @var DeploymentConfig
      */
@@ -65,7 +60,6 @@ public function __construct(
      *
      * @param  AbstractElement $element
      * @return string
-     * @throws LocalizedException
      */
     public function render(AbstractElement $element)
     {
@@ -96,16 +90,6 @@ public function getVersion()
         return $this->getComposerVersion($this->getModuleName());
     }
 
-    /**
-     * @return string
-     */
-    public function getModuleName()
-    {
-        $classArray = explode('\\', get_class($this));
-
-        return count($classArray) > 2 ? "{$classArray[0]}_{$classArray[1]}" : '';
-    }
-
     /**
      * Get module composer version
      *
@@ -128,7 +112,7 @@ public function getComposerVersion($moduleName)
                 return !empty($data->version) ? $data->version : __('Unknown');
             }
         } catch (Exception $e) {
-            //
+            return 'Unknown';
         }
 
         return 'Unknown';

diff --git a/Block/Adminhtml/System/Config/Form/Field/OrderIncrement.php b/Block/Adminhtml/System/Config/Form/Field/OrderIncrement.php
@@ -16,17 +16,19 @@
 use Magento\Config\Block\System\Config\Form\Field;
 use Magento\Framework\Data\Form\Element\AbstractElement;
 use Magento\Framework\DataObject;
+use Magento\Framework\Exception\LocalizedException;
+use Magento\Framework\Exception\NoSuchEntityException;
 use Magento\Sales\Model\Order;
 use Magento\Sales\Model\ResourceModel\Order\CollectionFactory;
 use Magento\Store\Api\Data\StoreInterface;
 
 /**
- * Class OrderIncrement
- * @package MagePal\PreviewCheckoutSuccessPage\Block\Adminhtml\System\Config\Form\Field
+ * @method setElement($element)
+ * @method getElement()
+ * @method getForm()
  */
 class OrderIncrement extends Field
 {
-
     /**
      * @var CollectionFactory
      */
@@ -50,28 +52,35 @@ public function __construct(
     /**
      * Get the grid and scripts contents
      *
-     * @param AbstractElement $element
+     * @param  AbstractElement  $element
      * @return string
      */
     protected function _getElementHtml(AbstractElement $element)
     {
         $this->setElement($element);
 
-        if (!$element->getEscapedValue()) {
+        try {
+            if (!$element->getEscapedValue()) {
 
-            /** @var Order $order */
-            $order = $this->getLastOrder();
+                /** @var Order $order */
+                $order = $this->getLastOrder();
 
-            if ($order->getId()) {
-                $element->setValue($order->getIncrementId());
+                if ($order->getId()) {
+                    $element->setValue($order->getIncrementId());
+                }
             }
+        } catch (\Exception $e) {
+            return parent::_getElementHtml($element);
         }
 
         return parent::_getElementHtml($element);
     }
 
     /**
      * @return StoreInterface|null
+     * @throws LocalizedException
+     * @throws NoSuchEntityException
+     * @return \Magento\Store\Api\Data\StoreInterface|null
      */
     public function getCurrentStore()
     {
@@ -89,6 +98,9 @@ public function getCurrentStore()
 
     /**
      * @return DataObject
+     * @throws LocalizedException
+     * @throws NoSuchEntityException
+     * @return Order
      */
     public function getLastOrder()
     {

diff --git a/Block/Adminhtml/System/Config/Form/Field/Preview.php b/Block/Adminhtml/System/Config/Form/Field/Preview.php
@@ -13,10 +13,6 @@
 use Magento\Framework\Url;
 use Magento\Store\Api\Data\StoreInterface;
 
-/**
- * Class Preview
- * @package MagePal\PreviewCheckoutSuccessPage\Block\Adminhtml\System\Config\Form\Field
- */
 class Preview extends Field
 {
     /**
@@ -44,7 +40,6 @@ public function __construct(
         parent::__construct($context, $data);
     }
 
-
     /**
      * @param AbstractElement $element
      * @return string
@@ -115,4 +110,14 @@ public function getSuccessPageUrl()
 
         return $this->urlHelper->setScope($store->getId())->getUrl('checkout/onepage/success', $routeParams);
     }
+
+    /**
+     * @return string
+     */
+    public function getSpinnerTemplate()
+    {
+        $value = '<div data-role=\"spinner\" style=\"text-align: center\"><div class=\"spinner\"><span></span><span>';
+        $value .= '</span><span></span><span></span><span></span><span></span><span></span><span></span></div></div>';
+        return $value;
+    }
 }
diff --git a/Block/Adminhtml/System/Config/Form/Module/Version.php b/Block/Adminhtml/System/Config/Form/Module/Version.php
diff --git a/Helper/Data.php b/Helper/Data.php
@@ -12,23 +12,10 @@
 use Magento\Store\Model\ScopeInterface;
 use MagePal\PreviewCheckoutSuccessPage\Model\Config\Backend\ValidFor;
 
-/**
- * Class Data
- * @package MagePal\PreviewCheckoutSuccessPage\Helper
- */
 class Data extends AbstractHelper
 {
     const XML_PATH_ACTIVE = 'magepal_checkout/preview_success_page/active';
 
-    /**
-     * @param Context $context
-     */
-    public function __construct(
-        Context $context
-    ) {
-        parent::__construct($context);
-    }
-
     /**
      * Whether is active
      *

diff --git a/Model/Config/Backend/AccessCode.php b/Model/Config/Backend/AccessCode.php
@@ -10,15 +10,12 @@
 use Magento\Framework\App\Config\ScopeConfigInterface;
 use Magento\Framework\App\Config\Value;
 use Magento\Framework\Data\Collection\AbstractDb;
+use Magento\Framework\Exception\LocalizedException;
 use Magento\Framework\Math\Random;
 use Magento\Framework\Model\Context;
 use Magento\Framework\Model\ResourceModel\AbstractResource;
 use Magento\Framework\Registry;
 
-/**
- * Class AccessCode
- * @package MagePal\PreviewCheckoutSuccessPage\Model\Config\Backend
- */
 class AccessCode extends Value
 {
 
@@ -34,29 +31,28 @@ class AccessCode extends Value
      * @param Registry $registry
      * @param ScopeConfigInterface $config
      * @param TypeListInterface $cacheTypeList
+     * @param Random $random
      * @param AbstractResource|null $resource
      * @param AbstractDb|null $resourceCollection
-     * @param Random $random
      * @param array $data
      */
     public function __construct(
         Context $context,
         Registry $registry,
         ScopeConfigInterface $config,
         TypeListInterface $cacheTypeList,
+        Random $random,
         AbstractResource $resource = null,
         AbstractDb $resourceCollection = null,
-        Random $random,
         array $data = []
-
     ) {
         $this->random = $random;
         parent::__construct($context, $registry, $config, $cacheTypeList, $resource, $resourceCollection, $data);
     }
 
     /**
      * @return $this
-     * @throws \Magento\Framework\Exception\LocalizedException
+     * @throws LocalizedException
      */
     public function beforeSave()
     {

diff --git a/Model/Config/Backend/ModifyTimestamp.php b/Model/Config/Backend/ModifyTimestamp.php
@@ -15,10 +15,6 @@
 use Magento\Framework\Registry;
 use Magento\Framework\Stdlib\DateTime\TimezoneInterface;
 
-/**
- * Class ModifyTimestamp
- * @package MagePal\PreviewCheckoutSuccessPage\Model\Config\Backend
- */
 class ModifyTimestamp extends Value
 {
 
@@ -44,11 +40,10 @@ public function __construct(
         Registry $registry,
         ScopeConfigInterface $config,
         TypeListInterface $cacheTypeList,
+        TimezoneInterface $localeDate,
         AbstractResource $resource = null,
         AbstractDb $resourceCollection = null,
-        TimezoneInterface $localeDate,
         array $data = []
-
     ) {
         $this->localeDate = $localeDate;
         parent::__construct($context, $registry, $config, $cacheTypeList, $resource, $resourceCollection, $data);

diff --git a/Model/Config/Backend/ValidFor.php b/Model/Config/Backend/ValidFor.php
@@ -8,10 +8,6 @@
 
 use Magento\Framework\App\Config\Value;
 
-/**
- * Class ValidFor
- * @package MagePal\PreviewCheckoutSuccessPage\Model\Config\Backend
- */
 class ValidFor extends Value
 {
     const MAX_ACCESS_TIME = 15;

diff --git a/Plugin/Model/Session/SuccessValidatorPlugin.php b/Plugin/Model/Session/SuccessValidatorPlugin.php
@@ -16,13 +16,8 @@
 use Magento\Sales\Model\ResourceModel\Order\CollectionFactory;
 use MagePal\PreviewCheckoutSuccessPage\Helper\Data;
 
-/**
- * Class SuccessValidatorPlugin
- * @package MagePal\PreviewCheckoutSuccessPage\Plugin\Model\Session
- */
 class SuccessValidatorPlugin
 {
-
     /** @var Data */
     protected $dataHelper;
 

diff --git a/composer.json b/composer.json
@@ -40,7 +40,7 @@
         "magepal/magento2-checkout-success-misc-script":"Add miscellaneous HTML and scripts to your checkout success page"
     },
     "type": "magento2-module",
-    "version": "1.0.9",
+    "version": "1.1.0",
     "autoload": {
         "files": [
             "registration.php"