Merge pull request #3 from Safemood/class-based-conditions

added Class-Based Conditions
Safemood · Jan 21, 2024 · 4cf8e65 · 4cf8e65
2 parents 02c32ba + 0e9f00d
commit 4cf8e65
Show file tree

Hide file tree

Showing 15 changed files with 180 additions and 20 deletions.
diff --git a/README.md b/README.md
@@ -35,13 +35,16 @@ php artisan vendor:publish --tag="discountify-config"
 This is the contents of the published config file:
 
 ```php
+// config/discountify.php
 return [
-    'global_discount' => 0,
-    'global_tax_rate' => 0,
+    'condition_namespace' => 'App\\Conditions',
+    'condition_path' => app_path('Conditions'),
     'fields' => [
-        'quantity' => 'quantity',
         'price' => 'price',
+        'quantity' => 'quantity',
     ],
+    'global_discount' => 0,
+    'global_tax_rate' => 0,
 ];
 ```
 

diff --git a/config/discountify.php b/config/discountify.php
@@ -1,10 +1,12 @@
 <?php
 
 return [
-    'global_discount' => 0,
-    'global_tax_rate' => 0,
+    'condition_namespace' => 'App\\Conditions',
+    'condition_path' => app_path('Conditions'),
     'fields' => [
-        'quantity' => 'quantity',
         'price' => 'price',
+        'quantity' => 'quantity',
     ],
+    'global_discount' => 0,
+    'global_tax_rate' => 0,
 ];
diff --git a/database/migrations/create_discountify_table.php.stub b/database/migrations/create_discountify_table.php.stub
@@ -16,4 +16,4 @@ return new class extends Migration
             $table->timestamps();
         });
     }
-};
+};
diff --git a/resources/views/.gitkeep b/resources/views/.gitkeep
diff --git a/src/Concerns/HasCalculations.php b/src/Concerns/HasCalculations.php
@@ -31,7 +31,7 @@ public function calculateTotalWithTaxes(?float $globalTaxRate = null): float
     /**
      * Calculate total with the discount.
      */
-    public function calculateDiscount(?float $globalDiscount = null): float
+    public function calculateDiscount(?int $globalDiscount = null): float
     {
         $this->globalDiscount = $globalDiscount ?? $this->globalDiscount;
 

diff --git a/src/ConditionManager.php b/src/ConditionManager.php
@@ -2,8 +2,10 @@
 
 namespace Safemood\Discountify;
 
+use Illuminate\Support\Collection;
 use InvalidArgumentException;
 use Safemood\Discountify\Contracts\ConditionManagerInterface;
+use Symfony\Component\Finder\Finder;
 
 /**
  * Class ConditionManager
@@ -29,13 +31,13 @@ public function add(array $conditions): self
      *
      * @return $this
      */
-    public function define(string $slug, callable $condition, float $discountPercentage): self
+    public function define(string $slug, callable $condition, float $discount): self
     {
         if (empty($slug)) {
             throw new InvalidArgumentException('Slug must be provided.');
         }
 
-        $this->conditions[] = compact('slug', 'condition', 'discountPercentage');
+        $this->conditions[] = compact('slug', 'condition', 'discount');
 
         return $this;
     }
@@ -45,9 +47,9 @@ public function define(string $slug, callable $condition, float $discountPercent
      *
      * @return $this
      */
-    public function defineIf(string $slug, bool $isAcceptable, float $discountPercentage): self
+    public function defineIf(string $slug, bool $isAcceptable, float $discount): self
     {
-        return $this->define($slug, fn () => $isAcceptable, $discountPercentage);
+        return $this->define($slug, fn () => $isAcceptable, $discount);
     }
 
     /**
@@ -57,4 +59,53 @@ public function getConditions(): array
     {
         return $this->conditions;
     }
+
+    /**
+     * Discover condition classes in a given namespace and path.
+     *
+     * @param  string  $namespace
+     * @param  string|null  $path
+     * @return $this
+     */
+    /**
+     * Discover condition classes in a given namespace and path.
+     *
+     * @param  string  $namespace
+     * @param  string|null  $path
+     * @return $this
+     */
+    public function discover($namespace = 'App\\Conditions', $path = null): self
+    {
+        $namespace = str()->finish($namespace, '\\');
+
+        $directory = $path ?? base_path('app/Conditions');
+
+        if (! is_dir($directory)) {
+            return $this;
+        }
+
+        Collection::make((new Finder)
+            ->files()
+            ->name('*.php')
+            ->depth(0)
+            ->in($directory))
+            ->each(function ($file) use ($namespace) {
+                $class = $namespace.$file->getBasename('.php');
+                $conditionInstance = new $class();
+
+                if (method_exists($conditionInstance, '__invoke')) {
+                    $slug = property_exists($conditionInstance, 'slug') ?
+                        $conditionInstance->slug : strtolower(str_replace($namespace, '', $class));
+
+                    $conditionCallback = fn ($items) => $conditionInstance->__invoke($items);
+
+                    $discount = property_exists($conditionInstance, 'discount') ?
+                        $conditionInstance->discount : 0;
+
+                    $this->define($slug, $conditionCallback, $discount);
+                }
+            });
+
+        return $this;
+    }
 }
diff --git a/src/Contracts/ConditionInterface.php b/src/Contracts/ConditionInterface.php
@@ -0,0 +1,11 @@
+<?php
+
+namespace Safemood\Discountify\Contracts;
+
+interface ConditionInterface
+{
+    /**
+     * Invoke the condition logic.
+     */
+    public function __invoke(array $items): bool;
+}
diff --git a/src/Contracts/ConditionManagerInterface.php b/src/Contracts/ConditionManagerInterface.php
@@ -8,9 +8,9 @@ interface ConditionManagerInterface
 {
     public function add(array $conditions): ConditionManager;
 
-    public function define(string $slug, callable $condition, float $discountPercentage): ConditionManager;
+    public function define(string $slug, callable $condition, float $discount): ConditionManager;
 
-    public function defineIf(string $slug, bool $condition, float $discountPercentage): ConditionManager;
+    public function defineIf(string $slug, bool $condition, float $discount): ConditionManager;
 
     public function getConditions(): array;
 }
diff --git a/src/Discountify.php b/src/Discountify.php
@@ -190,7 +190,7 @@ public function total(): float
     /**
      * Calculate the total with applied discount.
      */
-    public function totalWithDiscount(?float $globalDiscount = null): float
+    public function totalWithDiscount(?int $globalDiscount = null): float
     {
         return $this->calculateDiscount($globalDiscount);
     }

diff --git a/src/DiscountifyServiceProvider.php b/src/DiscountifyServiceProvider.php
@@ -19,8 +19,16 @@ public function configurePackage(Package $package): void
 
     public function packageRegistered()
     {
-        $this->app->singleton(ConditionManager::class, function () {
-            return new ConditionManager();
+
+        $this->app->singleton(ConditionManager::class, function ($app) {
+            $conditionManager = new ConditionManager();
+
+            $conditionManager->discover(
+                config('discountify.condition_namespace'),
+                config('discountify.condition_path')
+            );
+
+            return $conditionManager;
         });
 
         $this->app->singleton(Discountify::class, function (Application $app) {

diff --git a/src/Facades/Condition.php b/src/Facades/Condition.php
@@ -8,8 +8,8 @@
  * Class Condition
  *
  * @method static \Safemood\Discountify\ConditionManager add(array $conditions)
- * @method static \Safemood\Discountify\ConditionManager define(string $slug, callable $condition, float $discountPercentage)
- * @method static \Safemood\Discountify\ConditionManager defineIf(string $slug,bool $condition, float $discountPercentage)
+ * @method static \Safemood\Discountify\ConditionManager define(string $slug, callable $condition, float $discount)
+ * @method static \Safemood\Discountify\ConditionManager defineIf(string $slug,bool $condition, float $discount)
  * @method static array getConditions()
  * @method static array getItems()
  *

diff --git a/src/Facades/Discountify.php b/src/Facades/Discountify.php
@@ -15,7 +15,6 @@
  * @method static float getGlobalTaxRate()
  * @method static array getItems()
  * @method static float subtotal()
- * @method static float tax()
  * @method static float total()
  * @method static float totalWithDiscount(?float $globalDiscount = null)
  * @method static float tax(?float $globalTaxRate = null)

diff --git a/tests/DiscountifyTest.php b/tests/DiscountifyTest.php
@@ -6,6 +6,8 @@
 use Safemood\Discountify\Facades\Condition;
 use Safemood\Discountify\Facades\Discountify as DiscountifyFacade;
 
+use function Orchestra\Testbench\workbench_path;
+
 beforeEach(function () {
     $this->items = [
         ['id' => '1', 'quantity' => 2, 'price' => 50],
@@ -207,3 +209,53 @@
     expect(fn () => Condition::defineIf('', true, 10))
         ->toThrow(Exception::class, 'Slug must be provided.');
 });
+
+it('can auto register condition classes', function () {
+
+    Condition::discover(
+        'Workbench\\App\\Conditions',
+        workbench_path('app/Conditions')
+    );
+
+    $definedConditions = Condition::getConditions();
+
+    expect($definedConditions)
+        ->toBeArray()
+        ->toHaveCount(2)
+        ->each(function ($item) {
+            $item->toHaveKeys([
+                'slug',
+                'condition',
+                'discount',
+            ]);
+            $item->slug->toBeString();
+            $item->condition->toBeInstanceOf(Closure::class);
+            $item->discount->toBeFloat();
+        });
+});
+
+it('can work correctly with class-based conditions', function () {
+
+    $items = [
+        ['id' => '1', 'quantity' => 2, 'price' => 50],
+        ['id' => '2', 'quantity' => 1, 'price' => 100, 'type' => 'special'],
+    ];
+
+    Condition::discover(
+        'Workbench\\App\\Conditions',
+        workbench_path('app/Conditions')
+    );
+
+    DiscountifyFacade::setItems($items)
+        ->setGlobalTaxRate(19);
+
+    $total = DiscountifyFacade::total();
+    $totalWithDiscount = DiscountifyFacade::totalWithDiscount();
+    $totalWithTaxes = DiscountifyFacade::tax();
+    $taxRate = DiscountifyFacade::taxAmout(19);
+
+    expect($total)->toBe(floatval(138));
+    expect($totalWithDiscount)->toBe(floatval(100));
+    expect($totalWithTaxes)->toBe(floatval(238));
+    expect($taxRate)->toBe(floatval(38));
+});
diff --git a/workbench/app/Conditions/MoreThan1ProductsCondition.php b/workbench/app/Conditions/MoreThan1ProductsCondition.php
@@ -0,0 +1,17 @@
+<?php
+
+namespace Workbench\App\Conditions;
+
+use Safemood\Discountify\Contracts\ConditionInterface;
+
+class MoreThan1ProductsCondition implements ConditionInterface
+{
+    public string $slug = 'more_than_1_products_10';
+
+    public int $discount = 10;
+
+    public function __invoke(array $items): bool
+    {
+        return count($items) > 1;
+    }
+}
diff --git a/workbench/app/Conditions/SpecialTypeProductCondition.php b/workbench/app/Conditions/SpecialTypeProductCondition.php
@@ -0,0 +1,17 @@
+<?php
+
+namespace Workbench\App\Conditions;
+
+use Safemood\Discountify\Contracts\ConditionInterface;
+
+class SpecialTypeProductCondition implements ConditionInterface
+{
+    public string $slug = 'special_type_product_40';
+
+    public int $discount = 40;
+
+    public function __invoke(array $items): bool
+    {
+        return in_array('special', array_column($items, 'type'));
+    }
+}