Lint, added phpcs

silvershop · Feb 22, 2019 · b5bbc3b · b5bbc3b
1 parent 6a7bef8
commit b5bbc3b
Show file tree

Hide file tree

Showing 53 changed files with 618 additions and 363 deletions.
diff --git a/composer.json b/composer.json
@@ -1,12 +1,12 @@
 {
-	"name" : "silvershop/discounts",
-	"description" : "Adds Discount and Coupon support for SilverShop.",
-	"license" : "BSD-3-Clause",
-	"type" : "silverstripe-vendormodule",
-	"keywords" : ["silverstripe","shop","shopping cart","ecommerce","discount","coupons"],
-	"require" : {
-		"silvershop/core": "^3"
-	},
+    "name" : "silvershop/discounts",
+    "description" : "Adds Discount and Coupon support for SilverShop.",
+    "license" : "BSD-3-Clause",
+    "type" : "silverstripe-vendormodule",
+    "keywords" : ["silverstripe","shop","shopping cart","ecommerce","discount","coupons"],
+    "require" : {
+        "silvershop/core": "^3"
+    },
     "authors": [{
       "name": "SilverShop Contributors",
       "homepage": "https://github.com/silvershop/silvershop-stock/graphs/contributors"
@@ -15,6 +15,12 @@
         "phpunit/phpunit": "^5.7",
         "squizlabs/php_codesniffer": "^3.0"
     },
+    "scripts": {
+        "lint": "phpcs src/ tests/ --extensions=php",
+        "syntax-check": "find src/ tests/ -type f -name '*.php' -exec php -l {} \\;",
+        "lint-clean": "phpcbf src/ tests/ --extensions=php",
+        "remove-uses": "php-cs-fixer fix src/ --rules=no_unused_imports"
+    },
     "prefer-stable": false,
     "minimum-stability": "dev",
     "extra": {

diff --git a/phpcs.xml.dist b/phpcs.xml.dist
@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ruleset name="SilverStripe">
+    <description>CodeSniffer ruleset for SilverStripe coding conventions.</description>
+
+    <rule ref="PSR2" >
+        <!-- Current exclusions -->
+        <exclude name="PSR1.Methods.CamelCapsMethodName" />
+        <exclude name="PSR1.Files.SideEffects.FoundWithSymbols" />
+    </rule>
+</ruleset>
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -1,6 +1,6 @@
-<phpunit bootstrap="vendor/silverstripe/framework/tests/bootstrap.php" colors="true">
+<phpunit bootstrap="vendor/silverstripe/cms/tests/bootstrap.php" colors="true">
     <testsuite name="Default">
-        <directory>tests/php</directory>
+        <directory>tests/</directory>
     </testsuite>
 
     <filter>

diff --git a/src/Actions/ItemDiscountAction.php b/src/Actions/ItemDiscountAction.php
@@ -25,7 +25,7 @@ public function isForItems()
     /**
      * Checks if the given item qualifies for a discount.
      *
-     * @param ItemPriceInfo $info
+     * @param  ItemPriceInfo $info
      * @return boolean
      */
     protected function itemQualifies(ItemPriceInfo $info)

diff --git a/src/Actions/ItemFixedDiscount.php b/src/Actions/ItemFixedDiscount.php
@@ -3,7 +3,6 @@
 namespace SilverShop\Discounts\Actions;
 
 use SilverShop\Discounts\Adjustment;
-use SilverShop\Discounts\Actions\ItemDiscountAction;
 
 class ItemFixedDiscount extends ItemDiscountAction
 {

diff --git a/src/Actions/ItemPercentDiscount.php b/src/Actions/ItemPercentDiscount.php
@@ -3,7 +3,6 @@
 namespace SilverShop\Discounts\Actions;
 
 use SilverShop\Discounts\Adjustment;
-use SilverShop\Discounts\Actions\ItemDiscountAction;
 
 class ItemPercentDiscount extends ItemDiscountAction
 {

diff --git a/src/Admin/DiscountModelAdmin.php b/src/Admin/DiscountModelAdmin.php
@@ -81,10 +81,16 @@ public function getList()
             $list = $list
                 ->leftJoin("SilverShop_OrderItem_Discounts", "\"SilverShop_OrderItem_Discounts\".\"DiscountID\" = \"Discount\".\"ID\"")
                 ->leftJoin("SilverShop_OrderDiscountModifier_Discounts", "\"SilverShop_OrderDiscountModifier_Discounts\".\"DiscountID\" = \"Discount\".\"ID\"")
-                ->innerJoin("OrderAttribute", implode(" OR ", [
-                    "\"SilverShop_OrderAttribute\".\"ID\" = \"SilverShop_OrderItem_Discounts\".\"Product_OrderItemID\"",
-                    "\"SilverShop_OrderAttribute\".\"ID\" = \"SilverShop_OrderDiscountModifier_Discounts\".\"SilverShop_OrderDiscountModifierID\""
-                ]));
+                ->innerJoin(
+                    "OrderAttribute",
+                    implode(
+                        " OR ",
+                        [
+                        "\"SilverShop_OrderAttribute\".\"ID\" = \"SilverShop_OrderItem_Discounts\".\"Product_OrderItemID\"",
+                        "\"SilverShop_OrderAttribute\".\"ID\" = \"SilverShop_OrderDiscountModifier_Discounts\".\"SilverShop_OrderDiscountModifierID\""
+                        ]
+                    )
+                );
         }
 
         if (isset($params['Products'])) {
@@ -111,36 +117,47 @@ public function GenerateCouponsForm()
         $fields->removeByName('GiftVoucherID');
         $fields->removeByName('SaveNote');
 
-        $fields->addFieldsToTab("Root.Main", [
+        $fields->addFieldsToTab(
+            "Root.Main",
+            [
             NumericField::create('Number', 'Number of Coupons'),
-            FieldGroup::create("Code",
+            FieldGroup::create(
+                "Code",
                 TextField::create("Prefix", "Code Prefix")
                     ->setMaxLength(5),
-                DropdownField::create("Length", "Code Characters Length",
+                DropdownField::create(
+                    "Length",
+                    "Code Characters Length",
                     array_combine(range(5, 20), range(5, 20)),
                     OrderCoupon::config()->generated_code_length
                 )->setDescription("This is in addition to the length of the prefix.")
             )
-        ], "Title");
+            ],
+            "Title"
+        );
 
         $actions = new FieldList(
             new FormAction('generate', 'Generate')
         );
-        $validator = new RequiredFields([
+        $validator = new RequiredFields(
+            [
             'Title',
             'Number',
             'Type'
-        ]);
+            ]
+        );
         $form = new Form($this, "GenerateCouponsForm", $fields, $actions, $validator);
         $form->addExtraClass("cms-edit-form cms-panel-padded center ui-tabs-panel ui-widget-content ui-corner-bottom");
         $form->setAttribute('data-pjax-fragment', 'CurrentForm');
         $form->setHTMLID('Form_EditForm');
-        $form->loadDataFrom([
+        $form->loadDataFrom(
+            [
             'Number' => 1,
             'Active' => 1,
             'ForCart' => 1,
             'UseLimit' => 1
-        ]);
+            ]
+        );
         return $form;
     }
 

diff --git a/src/Admin/DiscountReport.php b/src/Admin/DiscountReport.php
@@ -46,10 +46,16 @@ public function query($params)
             ->selectField("COUNT(DISTINCT \"SilverShop_Order\".\"ID\")", 'Entered')
             ->addLeftJoin("SilverShop_OrderItem_Discounts", "\"SilverShop_OrderItem_Discounts\".\"SilverShop_DiscountID\" = \"SilverShop_Discount\".\"ID\"")
             ->addLeftJoin("SilverShop_OrderDiscountModifier_Discounts", "\"SilverShop_OrderDiscountModifier_Discounts\".\"SilverShop_DiscountID\" = \"SilverShop_Discount\".\"ID\"")
-            ->addInnerJoin("SilverShop_OrderAttribute", (implode(" OR ", [
-                "\"SilverShop_OrderItem_Discounts\".\"SilverShop_OrderItemID\" = \"SilverShop_OrderAttribute\".\"ID\"",
-                "\"SilverShop_OrderDiscountModifier_Discounts\".\"SilverShop_OrderDiscountModifierID\" = \"SilverShop_OrderAttribute\".\"ID\""
-            ])))
+            ->addInnerJoin(
+                "SilverShop_OrderAttribute",
+                (implode(
+                    " OR ",
+                    [
+                    "\"SilverShop_OrderItem_Discounts\".\"SilverShop_OrderItemID\" = \"SilverShop_OrderAttribute\".\"ID\"",
+                    "\"SilverShop_OrderDiscountModifier_Discounts\".\"SilverShop_OrderDiscountModifierID\" = \"SilverShop_OrderAttribute\".\"ID\""
+                    ]
+                ))
+            )
             ->addInnerJoin("SilverShop_Order", "\"SilverShop_OrderAttribute\".\"OrderID\" = \"SilverShop_Order\".\"ID\"");
         $query->setGroupBy("\"SilverShop_Discount\".\"ID\"");
         $query->setLimit("50");

diff --git a/src/Calculator.php b/src/Calculator.php
@@ -2,14 +2,12 @@
 
 namespace SilverShop\Discounts;
 
-use SilverShop\Discounts\Adjustment;
 use SilverShop\Discounts\Actions\SubtotalDiscountAction;
 use SilverShop\Discounts\Extensions\Constraints\ItemDiscountConstraint;
 use SilverShop\Discounts\Model\Discount;
 use SilverShop\Discounts\Model\Modifiers\OrderDiscountModifier;
 use SilverShop\Discounts\Actions\ItemPercentDiscount;
 use SilverShop\Discounts\Actions\ItemFixedDiscount;
-use SilverShop\Discounts\ItemPriceInfo;
 use SilverStripe\Core\Injector\Injectable;
 use SilverStripe\Core\Injector\Injector;
 use SilverShop\Model\Order;
@@ -38,13 +36,14 @@ public function __construct(Order $order, $context = [])
     /**
      * Work out the discount for a given order.
      *
-     * @param Order $order
+     * @param  Order $order
      * @return double - discount amount
      */
     public function calculate()
     {
         $this->modifier = $this->order->getModifier(
-            OrderDiscountModifier::class, true
+            OrderDiscountModifier::class,
+            true
         );
 
         $total = 0;
@@ -56,7 +55,6 @@ public function calculate()
         $infoitems = $this->createPriceInfoList($this->order->Items());
 
         foreach ($this->getItemDiscounts() as $discount) {
-
             // item discounts will update info items
             $action = $discount->Type === "Percent" ?
                 Injector::inst()->createWithArgs(ItemPercentDiscount::class, [$infoitems, $discount]) :
@@ -186,8 +184,8 @@ protected function getDiscountableAmount($discount)
     protected function discountSubtotal($discount)
     {
         return $this->modifier->Discounts()
-                    ->filter("ID", $discount->ID)
-                    ->sum("DiscountAmount");
+            ->filter("ID", $discount->ID)
+            ->sum("DiscountAmount");
     }
 
     /**
@@ -226,9 +224,10 @@ protected function getShippingDiscounts()
 
     /**
      * Store details about discounts for loggging / debubgging
-     * @param  string   $level
-     * @param  double   $amount
-     * @param  Discount $discount
+     *
+     * @param string   $level
+     * @param double   $amount
+     * @param Discount $discount
      */
     public function logDiscountAmount($level, $amount, Discount $discount)
     {

diff --git a/src/Checkout/CouponCheckoutComponent.php b/src/Checkout/CouponCheckoutComponent.php
@@ -19,9 +19,13 @@ class CouponCheckoutComponent extends CheckoutComponent
     public function getFormFields(Order $order)
     {
         $fields = FieldList::create(
-            TextField::create('Code', _t("CouponForm.COUPON",
-                'Enter your coupon code if you have one.'
-            ))
+            TextField::create(
+                'Code',
+                _t(
+                    "CouponForm.COUPON",
+                    'Enter your coupon code if you have one.'
+                )
+            )
         );
 
         return $fields;

diff --git a/src/Checkout/Step/CheckoutStepDiscount.php b/src/Checkout/Step/CheckoutStepDiscount.php
@@ -38,9 +38,11 @@ public function discount()
     public function CouponForm()
     {
         $form = new CheckoutForm($this->owner, 'CouponForm', $this->checkoutconfig());
-        $form->setActions(new FieldList(
-            FormAction::create("setcoupon", _t('SilverShop\Checkout\Step\CheckoutStep.Continue', 'Continue'))
-        ));
+        $form->setActions(
+            new FieldList(
+                FormAction::create("setcoupon", _t('SilverShop\Checkout\Step\CheckoutStep.Continue', 'Continue'))
+            )
+        );
         $this->owner->extend('updateCouponForm', $form);
 
         return $form;

diff --git a/src/Extensions/Constraints/CategoriesDiscountConstraint.php b/src/Extensions/Constraints/CategoriesDiscountConstraint.php
@@ -4,7 +4,6 @@
 
 use SilverShop\Discounts\Model\Discount;
 use SilverStripe\Forms\FieldList;
-use SilverStripe\Forms\Tab;
 use SilverStripe\Forms\GridField\GridField;
 use SilverStripe\Forms\GridField\GridFieldConfig_RelationEditor;
 use SilverStripe\Forms\GridField\GridFieldAddNewButton;
@@ -21,7 +20,8 @@ class CategoriesDiscountConstraint extends ItemDiscountConstraint
     public function updateCMSFields(FieldList $fields)
     {
         if ($this->owner->isInDB()) {
-            $fields->addFieldToTab("Root.Constraints.ConstraintsTabs.Product",
+            $fields->addFieldToTab(
+                "Root.Constraints.ConstraintsTabs.Product",
                 GridField::create(
                     "Categories",
                     _t(__CLASS__.'.PRODUCTCATEGORIES', "Product categories"),

diff --git a/src/Extensions/Constraints/DatetimeDiscountConstraint.php b/src/Extensions/Constraints/DatetimeDiscountConstraint.php
@@ -17,7 +17,8 @@ class DatetimeDiscountConstraint extends DiscountConstraint
 
     public function updateCMSFields(FieldList $fields)
     {
-        $fields->addFieldToTab("Root.Constraints.ConstraintsTabs.General",
+        $fields->addFieldToTab(
+            "Root.Constraints.ConstraintsTabs.General",
             FieldGroup::create(
                 _t(__CLASS__.'.VALIDDATERANGE', "Valid date range:"),
                 DatetimeField::create(
@@ -43,9 +44,9 @@ public function filter(DataList $list)
         return $list->where(
             "(\"SilverShop_Discount\".\"StartDate\" IS NULL) OR (\"SilverShop_Discount\".\"StartDate\" < '$datetime')"
         )
-        ->where(
-            "(\"SilverShop_Discount\".\"EndDate\" IS NULL) OR (\"SilverShop_Discount\".\"EndDate\" > '$datetime')"
-        );
+            ->where(
+                "(\"SilverShop_Discount\".\"EndDate\" IS NULL) OR (\"SilverShop_Discount\".\"EndDate\" > '$datetime')"
+            );
     }
 
     public function check(Discount $discount)

diff --git a/src/Extensions/Constraints/DiscountConstraint.php b/src/Extensions/Constraints/DiscountConstraint.php
@@ -6,8 +6,6 @@
 use SilverStripe\ORM\DataExtension;
 use SilverShop\Model\Order;
 use SilverStripe\ORM\DataList;
-use SilverStripe\Core\Config\Config;
-use SilverStripe\Core\Injector\Injector;
 
 /**
  * Encapsulate a single kind of constraint.

diff --git a/src/Extensions/Constraints/GroupDiscountConstraint.php b/src/Extensions/Constraints/GroupDiscountConstraint.php
@@ -2,14 +2,12 @@
 
 namespace SilverShop\Discounts\Extensions\Constraints;
 
-
 use SilverShop\Discounts\Model\Discount;
 use SilverStripe\Forms\FieldList;
 use SilverStripe\Forms\DropdownField;
 use SilverStripe\Security\Group;
 use SilverStripe\ORM\DataList;
 
-
 class GroupDiscountConstraint extends DiscountConstraint
 {
     private static $has_one = [
@@ -18,8 +16,10 @@ class GroupDiscountConstraint extends DiscountConstraint
 
     public function updateCMSFields(FieldList $fields)
     {
-        $fields->addFieldToTab("Root.Constraints.ConstraintsTabs.Membership",
-            DropdownField::create("GroupID",
+        $fields->addFieldToTab(
+            "Root.Constraints.ConstraintsTabs.Membership",
+            DropdownField::create(
+                "GroupID",
                 _t(__CLASS__.'.MEMBERISINGROUP', "Member is in group"),
                 Group::get()->map('ID', 'Title')
             )->setHasEmptyDefault(true)
@@ -32,8 +32,8 @@ public function filter(DataList $list)
         $groupids = [0];
         if ($member = $this->getMember()) {
             $groupids = $groupids + $member->Groups()
-                                        ->map('ID', 'ID')
-                                        ->toArray();
+                ->map('ID', 'ID')
+                ->toArray();
         }
 
         return $list->filter("GroupID", $groupids);
@@ -44,10 +44,12 @@ public function check(Discount $discount)
         $group = $discount->Group();
         $member = $this->getMember();
         if ($group->exists() && (!$member || !$member->inGroup($group))) {
-            $this->error(_t(
-                "Discount.GROUPED",
-                "Only specific members can use this discount."
-            ));
+            $this->error(
+                _t(
+                    "Discount.GROUPED",
+                    "Only specific members can use this discount."
+                )
+            );
             return false;
         }
 

diff --git a/src/Extensions/Constraints/ItemDiscountConstraint.php b/src/Extensions/Constraints/ItemDiscountConstraint.php
@@ -2,7 +2,6 @@
 
 namespace SilverShop\Discounts\Extensions\Constraints;
 
-use SilverShop\Discounts\Extensions\Constraints\DiscountConstraint;
 use SilverShop\Model\OrderItem;
 use SilverShop\Discounts\Model\Discount;
 use SilverStripe\Core\ClassInfo;