Add product-price hook (#286)

Author: ryanmitchell

docs/content/en/frontend/tags.md

@@ -53,6 +53,20 @@ From £50.00
 £4.99
 ```
 
+#### product-price hook
+
+This tag provides a [Hook](https://statamic.dev/extending/hooks) to modify the price and currency. For example, if you wanted to format the price using PHP's NumberFormatter:
+
+```php
+\StatamicRadPack\Shopify\Tags\Shopify::hook('product-price', function ($payload, $next) {
+    $formatter = new \NumberFormatter(\Statamic\Facades\Site::current()->locale(), \NumberFormatter::CURRENCY);
+
+    $payload->price = $formatter->formatCurrency((float) $payload->price, 'EUR');
+    
+    return $next($payload);
+});
+```
+
 ## Product Variants
 
 You can interact with the variants in several ways. In the demo theme we output this automatically, but you may want to drill down deeper.

src/Tags/Shopify.php

@@ -8,6 +8,7 @@
 use Statamic\Facades\User;
 use Statamic\Support\Arr;
 use Statamic\Support\Str;
+use Statamic\Support\Traits\Hookable;
 use Statamic\Tags\Concerns\GetsRedirects;
 use Statamic\Tags\Concerns\OutputsItems;
 use Statamic\Tags\Concerns\QueriesConditions;
@@ -17,7 +18,7 @@
 
 class Shopify extends Tags
 {
-    use GetsRedirects, OutputsItems, QueriesConditions, QueriesOrderBys, RendersForms;
+    use GetsRedirects, Hookable, OutputsItems, QueriesConditions, QueriesOrderBys, RendersForms;
 
     /**
      * @return string|array
@@ -52,8 +53,6 @@ public function productPrice()
             return null;
         }
 
-        $html = '';
-
         // Out of Stock
         if (! $this->isInStock($variants)) {
             return __('shopify::messages.out_of_stock');
@@ -62,13 +61,18 @@ public function productPrice()
         // Lowest Price
         $pricePluck = $variants->pluck('price');
 
-        $price = $pricePluck->sort()->splice(0, 1)[0];
+        $price = $pricePluck->sort()->first();
+
+        $payload = $this->runHooksWith('product-price', [
+            'currency' => config('shopify.currency'),
+            'price' => $price,
+        ]);
 
         if ($pricePluck->count() > 1 && $this->params->get('show_from') === true) {
-            return __('shopify::messages.display_price_from', ['currency' => config('shopify.currency'), 'price' => $price]);
+            return __('shopify::messages.display_price_from', ['currency' => $payload->currency, 'price' => $payload->price]);
         }
 
-        return __('shopify::messages.display_price', ['currency' => config('shopify.currency'), 'price' => $price]);
+        return __('shopify::messages.display_price', ['currency' => $payload->currency, 'price' => $payload->price]);
     }
 
     /**

tests/Unit/TagsTest.php

@@ -7,6 +7,7 @@
 use Shopify\Clients\Rest;
 use Shopify\Clients\RestResponse;
 use Statamic\Facades;
+use StatamicRadPack\Shopify\Tags\Shopify;
 use StatamicRadPack\Shopify\Tests\TestCase;
 
 class TagsTest extends TestCase
@@ -81,6 +82,43 @@ public function outputs_product_price()
 
     }
 
+    #[Test]
+    public function runs_hooks_on_product_price()
+    {
+        $product = Facades\Entry::make()->data([
+            'title' => 'Obi wan',
+            'vendor' => 'Kenobe',
+            'slug' => 'obi-wan',
+            'product_id' => 1,
+        ])
+            ->collection('products');
+
+        $product->save();
+
+        $variant = Facades\Entry::make()->data([
+            'title' => 'T-shirt',
+            'slug' => 'obi-wan-tshirt',
+            'sku' => 'obi-wan-tshirt',
+            'product_slug' => 'obi-wan',
+            'price' => 1999.99,
+            'inventory_quantity' => 10,
+            'inventory_policy' => 'deny',
+            'inventory_management' => 'shopify',
+        ])
+            ->collection('variants');
+
+        $variant->save();
+
+        Shopify::hook('product-price', function ($payload, $next) {
+            $payload->price = '10.00';
+            $payload->currency = '$';
+
+            return $next($payload);
+        });
+
+        $this->assertEquals('$10.00', $this->tag('{{ shopify:product_price }}', ['slug' => 'obi-wan']));
+    }
+
     #[Test]
     public function outputs_in_stock()
     {