Improved rapidez/statamic compatibility (#1175)

Author: Jade-GG

resources/views/product/overview.blade.php

@@ -44,7 +44,7 @@
                             <dt>SKU</dt>
                             <dd>{{ $product->sku }}</dd>
                             @foreach (\Rapidez\Core\Models\EavAttribute::getCachedCatalog()->where(fn ($attribute) => $attribute->is_visible_on_front) as $attribute)
-                                @if (($value = $product->{$attribute['attribute_code']}))
+                                @if (($value = $product->label($attribute['attribute_code'])))
                                     <dt>{{ $attribute['frontend_label'] }}</dt>
                                     @if ($attribute['is_html_allowed_on_front'])
                                         <dd>{!! $value !!}</dd>

src/Models/ProductLink.php

@@ -5,28 +5,20 @@
 use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Relations\HasMany;
 use Illuminate\Database\Eloquent\Relations\HasOne;
-use Rapidez\Core\Models\Traits\HasCustomAttributes;
 
 class ProductLink extends Model
 {
-    use HasCustomAttributes;
-
     const CREATED_AT = null;
     const UPDATED_AT = null;
 
     protected $table = 'catalog_product_link';
 
-    protected $attributeTypes = ['int', 'decimal', 'varchar'];
-    protected $attributeTablePrefix = 'catalog_product_link_attribute';
-    protected $attributeCode = 'product_link_attribute_code';
-
     protected $primaryKey = 'link_id';
 
     protected static function boot()
     {
         parent::boot();
 
-        static::withCustomAttributes();
         static::addGlobalScope('withLinkType', fn (Builder $builder) => $builder->join('catalog_product_link_type', 'catalog_product_link_type.link_type_id', '=', 'catalog_product_link.link_type_id'));
     }
 

src/Models/Scopes/Product/ForCurrentWebsiteScope.php

@@ -10,7 +10,7 @@ class ForCurrentWebsiteScope implements Scope
 {
     public function apply(Builder $builder, Model $model)
     {
-        $builder->leftJoin('catalog_product_website', 'catalog_product_website.product_id', '=', $model->getQualifiedKeyName());
+        $builder->leftJoin('catalog_product_website', 'catalog_product_website.product_id', '=', $model->qualifyColumn('entity_id'));
         $builder->where('website_id', config('rapidez.website'));
     }
 }

src/Models/Traits/HasCustomAttributes.php

@@ -130,8 +130,8 @@ public function attributeDatetime(): HasMany
         return $this->hasManyWithAttributeTypeTable(
             config('rapidez.models.attribute_datetime', AttributeDatetime::class),
             'datetime',
-            $this->primaryKey,
-            $this->primaryKey,
+            'entity_id',
+            'entity_id',
         );
     }
 
@@ -140,8 +140,8 @@ public function attributeDecimal(): HasMany
         return $this->hasManyWithAttributeTypeTable(
             config('rapidez.models.attribute_decimal', AttributeDecimal::class),
             'decimal',
-            $this->primaryKey,
-            $this->primaryKey,
+            'entity_id',
+            'entity_id',
         );
     }
 
@@ -150,8 +150,8 @@ public function attributeInt(): HasMany
         return $this->hasManyWithAttributeTypeTable(
             config('rapidez.models.attribute_int', AttributeInt::class),
             'int',
-            $this->primaryKey,
-            $this->primaryKey,
+            'entity_id',
+            'entity_id',
         );
     }
 
@@ -160,8 +160,8 @@ public function attributeText(): HasMany
         return $this->hasManyWithAttributeTypeTable(
             config('rapidez.models.attribute_text', AttributeText::class),
             'text',
-            $this->primaryKey,
-            $this->primaryKey,
+            'entity_id',
+            'entity_id',
         );
     }
 
@@ -170,8 +170,8 @@ public function attributeVarchar(): HasMany
         return $this->hasManyWithAttributeTypeTable(
             config('rapidez.models.attribute_varchar', AttributeVarchar::class),
             'varchar',
-            $this->primaryKey,
-            $this->primaryKey,
+            'entity_id',
+            'entity_id',
         );
     }
 
@@ -214,11 +214,39 @@ public function customAttributes(): AttributeCast
 
     public function getCustomAttribute($key)
     {
+        if (! $this->exists) {
+            return null;
+        }
+
         return $this->customAttributes[$key] ?? null;
     }
 
+    public function hasCustomAttribute($key): bool
+    {
+        return $this->exists && isset($this->customAttributes[$key]);
+    }
+
     protected function throwMissingAttributeExceptionIfApplicable($key)
     {
-        return $this->getCustomAttribute($key);
+        if ($this->hasCustomAttribute($key)) {
+            return $this->value($key);
+        }
+
+        return parent::throwMissingAttributeExceptionIfApplicable($key);
+    }
+
+    public function value(string $key): mixed
+    {
+        return $this->getCustomAttribute($key)?->value ?? null;
+    }
+
+    public function raw(string $key): mixed
+    {
+        return $this->getCustomAttribute($key)?->rawValue ?? null;
+    }
+
+    public function label(string $key): ?string
+    {
+        return $this->getCustomAttribute($key)?->label ?? null;
     }
 }

src/Models/Traits/Product/HasSuperAttributes.php

@@ -38,7 +38,7 @@ public function superAttributeValues(): Attribute
             ->mapWithKeys(fn ($attribute) => [
                 $attribute->attribute_code => $this->children
                     ->mapWithKeys(fn ($child) => [
-                        $child->entity_id => $child->{$attribute->attribute_code},
+                        $child->entity_id => $child->getCustomAttribute($attribute->attribute_code),
                     ])
                     ->sortBy('sort_order')
                     ->groupBy('rawValue')

src/Models/Traits/Product/Searchable.php

@@ -146,7 +146,7 @@ public function withCategories(array $data): array
             for ($i = 1; $i <= $level; $i++) {
                 $pathCategories = collect($path)
                     ->take($i)
-                    ->map(fn ($id) => $categories[$id]->name->value ?? null)
+                    ->map(fn ($id) => $categories[$id]->name ?? null)
                     ->whereNotNull()
                     ->join(' > ');
 

tests/Unit/ProductTest.php

@@ -161,12 +161,11 @@ public function product_has_custom_attributes()
     {
         $product = Product::find(10);
 
-        $this->assertEqualsCanonicalizing([8, 11], iterator_to_array($product->activity->rawValue), 'Activity attribute on product 10 did not return the right values.');
-        $this->assertEqualsCanonicalizing(['Gym', 'Yoga'], iterator_to_array($product->activity->value), 'Activity attribute on product 10 did not return the right values.');
-        $this->assertEquals('Gym, Yoga', $product->activity->label, 'Activity attribute on product 10 did not yield the right text output.');
+        $this->assertEqualsCanonicalizing([8, 11], iterator_to_array($product->raw('activity')), 'Activity attribute on product 10 did not return the right values.');
+        $this->assertEqualsCanonicalizing(['Gym', 'Yoga'], iterator_to_array($product->activity), 'Activity attribute on product 10 did not return the right values.');
+        $this->assertEquals('Gym, Yoga', $product->label('activity'), 'Activity attribute on product 10 did not yield the right text output.');
 
-        $this->assertEquals('Savvy Shoulder Tote', $product->name->label, 'Name attribute on product 10 did not return the right value.');
-        $this->assertEquals($product->name->label, $product->name, 'Product name did not return the right value or did not cast its value correctly.');
+        $this->assertEquals('Savvy Shoulder Tote', $product->label('name'), 'Name attribute on product 10 did not return the right label.');
     }
 
     #[Test]